|
| 1 | +# Contributing to GPT Researcher |
| 2 | +First off, we'd like to welcome and thank you for your interest and effort in contributing to our open source project ❤️. Contributions of all forms are welcome, from new features and bug fixes, to documentation and more. |
| 3 | + |
| 4 | +We are on a mission to build the #1 AI agent for comprehensive, unbiased, and factual research online. And we need your support to achieve this grand vision. |
| 5 | + |
| 6 | +Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved. |
| 7 | + |
| 8 | +## Reporting Issues |
| 9 | + |
| 10 | +If you come across any issue or have an idea for an improvement, don't hesitate to create an issue on GitHub. Describe your problem in sufficient detail, providing as much relevant information as possible. This way, we can reproduce the issue before attempting to fix it or respond appropriately. |
| 11 | + |
| 12 | +## Contributing Code |
| 13 | + |
| 14 | +1. **Fork the repository and create your branch from `master`.** |
| 15 | +If it's not an urgent bug fix, you should branch from `master` and work on the feature or fix in there. |
| 16 | + |
| 17 | +2. **Conduct your changes.** |
| 18 | +Make your changes following best practices for coding in the project's language. |
| 19 | + |
| 20 | +3. **Test your changes.** |
| 21 | +Make sure your changes pass all the tests if there are any. If the project doesn't have automated testing infrastructure, test your changes manually to confirm they behave as expected. |
| 22 | + |
| 23 | +4. **Follow the coding style.** |
| 24 | +Ensure your code adheres to the coding conventions used throughout the project, that includes indentation, accurate comments, etc. |
| 25 | + |
| 26 | +5. **Commit your changes.** |
| 27 | +Make your git commits informative and concise. This is very helpful for others when they look at the git log. |
| 28 | + |
| 29 | +6. **Push to your fork and submit a pull request.** |
| 30 | +When your work is ready and passes tests, push your branch to your fork of the repository and submit a pull request from there. |
| 31 | + |
| 32 | +7. **Pat your back and wait for the review.** |
| 33 | +Your work is done, congratulations! Now sit tight. The project maintainers will review your submission as soon as possible. They might suggest changes or ask for improvements. Both constructive conversation and patience are key to the collaboration process. |
| 34 | + |
| 35 | + |
| 36 | +## Documentation |
| 37 | + |
| 38 | +If you would like to contribute to the project's documentation, please follow the same steps: fork the repository, make your changes, test them, and submit a pull request. |
| 39 | + |
| 40 | +Documentation is a vital part of any software. It's not just about having good code. Ensuring that the users and contributors understand what's going on, how to use the software or how to contribute, is crucial. |
| 41 | + |
| 42 | +We're grateful for all our contributors, and we look forward to building the world's leading AI research agent hand-in-hand with you. Let's harness the power of Open Source and AI to change the world together! |
0 commit comments