diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0529cbd94..49c95991a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,41 +8,49 @@ To contribute to this GitHub project, you can follow these steps: ``` git clone https://github.com//Auto-GPT ``` -3. Create a new branch for your changes using the following command: +3. Install the project requirements +``` +pip install -r requirements.txt +``` +4. Install pre-commit hooks +``` +pre-commit install +``` +5. Create a new branch for your changes using the following command: ``` git checkout -b "branch-name" ``` -4. Make your changes to the code or documentation. +6. Make your changes to the code or documentation. - Example: Improve User Interface or Add Documentation. -5. Add the changes to the staging area using the following command: +7. Add the changes to the staging area using the following command: ``` git add . ``` -6. Commit the changes with a meaningful commit message using the following command: +8. Commit the changes with a meaningful commit message using the following command: ``` git commit -m "your commit message" ``` -7. Push the changes to your forked repository using the following command: +9. Push the changes to your forked repository using the following command: ``` git push origin branch-name ``` -8. Go to the GitHub website and navigate to your forked repository. +10. Go to the GitHub website and navigate to your forked repository. -9. Click the "New pull request" button. +11. Click the "New pull request" button. -10. Select the branch you just pushed to and the branch you want to merge into on the original repository. +12. Select the branch you just pushed to and the branch you want to merge into on the original repository. -11. Add a description of your changes and click the "Create pull request" button. +13. Add a description of your changes and click the "Create pull request" button. -12. Wait for the project maintainer to review your changes and provide feedback. +14. Wait for the project maintainer to review your changes and provide feedback. -13. Make any necessary changes based on feedback and repeat steps 5-12 until your changes are accepted and merged into the main project. +15. Make any necessary changes based on feedback and repeat steps 5-12 until your changes are accepted and merged into the main project. -14. Once your changes are merged, you can update your forked repository and local copy of the repository with the following commands: +16. Once your changes are merged, you can update your forked repository and local copy of the repository with the following commands: ``` git fetch upstream