ai-assistant-android/CONTRIBUTING.md

Contributing to AI Assistant Android

Thank you for your interest in contributing. This is one of my side projects and I want to maintain a strict scope to ensure the project remains manageable.

Contribution Scope and Policy

Please read this section carefully before starting any work.

Area	Status	Policy
New Features	NOT ACCEPTED	DO NOT submit a Pull Request (PR) for a new feature without opening a detailed GitHub Issue first and receiving explicit owner approval. Unsolicited feature PRs will be closed immediately.
Bugs/Refactoring	HIGHLY ACCEPTED	Bug fixes, documentation improvements, and minor code cleanup/refactoring are highly welcome.
Review Time	LIMITED & IRREGULAR	As this is a personal side project, my review time is limited. PRs may take several weeks to a month or more to be reviewed and merged. Your patience is appreciated.

Setting Up the Development Environment

API Key Setup

This application requires external API keys mentioned in Readme file to function during development. You must use your own key.

• Obtain Your Key: Get your personal API key, refer readme file for details.
• Security Note: The local.properties file is included in .gitignore and must not be committed to the repository.

Contribution Workflow

1. Fork the repository to your own GitHub account.
2. Clone your fork locally.
3. Create a new, descriptive branch (e.g., fix/settings-crash or docs/update-readme).
4. Implement your change. Ensure all existing functionality remains intact.
5. Commit your changes with clear, concise, and descriptive messages.
6. Push the branch to your fork.
7. Open a Pull Request (PR) from your branch to the main branch of the original repository.

Thank you for taking the time to contribute responsibly!