|
| 1 | +# Contributing to PR-Agent |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the PR-Agent project! |
| 4 | + |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +1. Fork the repository and clone your fork |
| 8 | +2. Install Python 3.10 or higher |
| 9 | +3. Install dependencies (`requirements.txt` and `requirements-dev.txt`) |
| 10 | +4. Create a new branch for your contribution: |
| 11 | + - For new features: `git checkout -b feature/your-feature-name` |
| 12 | + - For bug fixes: `git checkout -b fix/issue-description` |
| 13 | +5. Make your changes |
| 14 | +6. Write or update tests as needed |
| 15 | +7. Run tests locally to ensure everything passes |
| 16 | +8. Commit your changes using conventional commit messages |
| 17 | +9. Push to your fork and submit a pull request |
| 18 | + |
| 19 | +## Development Guidelines |
| 20 | + |
| 21 | +- Keep pull requests focused on a single feature or fix |
| 22 | +- Follow the existing code style and formatting conventions |
| 23 | +- Add unit tests for any new functionality using pytest |
| 24 | +- Ensure test coverage for your changes |
| 25 | +- Update documentation as needed |
| 26 | + |
| 27 | +## Pull Request Process |
| 28 | + |
| 29 | +1. Ensure your PR includes a clear description of the changes |
| 30 | +2. Link any related issues |
| 31 | +3. Update the README.md if needed |
| 32 | +4. Wait for review from maintainers |
| 33 | + |
| 34 | +## Questions or Need Help? |
| 35 | + |
| 36 | +- Join our [Discord community](https://discord.com/channels/1057273017547378788/1126104260430528613) for questions and discussions |
| 37 | +- Check the [documentation](https://qodo-merge-docs.qodo.ai/) for detailed information |
| 38 | +- Report bugs or request features through [GitHub Issues](https://github.com/qodo-ai/pr-agent/issues) |
0 commit comments