-
Notifications
You must be signed in to change notification settings - Fork 668
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1500 from qodo-ai/of/add-contributing-file
Add CONTRIBUTING.md with contribution guidelines and setup instructions
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Contributing to PR-Agent | ||
|
||
Thank you for your interest in contributing to the PR-Agent project! | ||
|
||
## Getting Started | ||
|
||
1. Fork the repository and clone your fork | ||
2. Install Python 3.10 or higher | ||
3. Install dependencies (`requirements.txt` and `requirements-dev.txt`) | ||
4. Create a new branch for your contribution: | ||
- For new features: `git checkout -b feature/your-feature-name` | ||
- For bug fixes: `git checkout -b fix/issue-description` | ||
5. Make your changes | ||
6. Write or update tests as needed | ||
7. Run tests locally to ensure everything passes | ||
8. Commit your changes using conventional commit messages | ||
9. Push to your fork and submit a pull request | ||
|
||
## Development Guidelines | ||
|
||
- Keep pull requests focused on a single feature or fix | ||
- Follow the existing code style and formatting conventions | ||
- Add unit tests for any new functionality using pytest | ||
- Ensure test coverage for your changes | ||
- Update documentation as needed | ||
|
||
## Pull Request Process | ||
|
||
1. Ensure your PR includes a clear description of the changes | ||
2. Link any related issues | ||
3. Update the README.md if needed | ||
4. Wait for review from maintainers | ||
|
||
## Questions or Need Help? | ||
|
||
- Join our [Discord community](https://discord.com/channels/1057273017547378788/1126104260430528613) for questions and discussions | ||
- Check the [documentation](https://qodo-merge-docs.qodo.ai/) for detailed information | ||
- Report bugs or request features through [GitHub Issues](https://github.com/qodo-ai/pr-agent/issues) |