diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3a35dc8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,82 @@ +# Contributing to Devr.AI +Thank you for your interest in contributing to **Devr.AI** +We welcome contributions from developers of all experience levels and appreciate your time and effort. + +This document provides guidelines to help you contribute effectively and collaborate smoothly with the community. + + +## Code of Conduct +Please read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md). +We are committed to maintaining a respectful, inclusive, and harassment-free environment for everyone. + + +## How You Can Contribute +You can contribute to Devr.AI in many ways, including but not limited to: +1. Reporting bugs +2. Suggesting new features or improvements +3. Improving documentation +4. Fixing existing issues +5. Reviewing pull requests + +Before starting work, please check the **Issues** tab and look for: +- `good first issue` +- `bug` +- `enhancement` + +If you plan to work on an issue, leave a comment to let others know. + + +## Getting Started +### 1. Fork the Repository +Click the **Fork** button on GitHub to create your own copy of the repository. + +### 2. Clone Your Fork +```bash +git clone https://github.com//Devr.AI.git +cd Devr.AI +``` + + +## Development Setup +Devr.AI uses a multi-service architecture involving AI agents, message queues, and multiple databases. + +Please follow the official setup instructions here: +- [Installation Guide](./docs/INSTALL_GUIDE.md) + +This guide covers environment variables, database setup, and running the backend and frontend locally. + + +## Branch Naming Convention +Create a new branch for every change. + +Recommended formats: +- `feat/short-description` +- `fix/issue-description` +- `docs/update-documentation` +- `chore/cleanup-task` + +Example: +```bash +git checkout -b docs/add-contributing-md +``` + + +## Pull Request Guidelines +Before submitting a PR: +1. Keep changes small and focused +2. Update your branch with main +3. Clearly explain what, why, and how +4. Link issues using Closes #issue-number + +After submitting: +1. Respond to review comments politely +2. Make requested changes in the same PR + + +## Getting Help +If you need help: +1. Join our Discord +2. Use GitHub Discussions +3. Ask in the issue you are working on + +Thank you for contributing to Devr.AI!