CONTRIBUTING.md

To contribute to this GitHub project, you can follow these steps:

1. Fork the repository you want to contribute to by clicking the "Fork" button on the project page.

2. Clone the repository to your local machine using the following command:

git clone https://github.com/<YOUR-GITHUB-USERNAME>/DB-GPT

3. Install the project requirements

pip install -e ".[default]"

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"

6. Make your changes to the code or documentation.

• Example: Improve User Interface or Add Documentation.

7. Format the code using the following command:

make fmt

8. Add the changes to the staging area using the following command:

git add .

9. Make sure the tests pass and your code lints using the following command:

make pre-commit

10. Commit the changes with a meaningful commit message using the following command:

git commit -m "your commit message"

11. Push the changes to your forked repository using the following command:

git push origin branch-name

12. Go to the GitHub website and navigate to your forked repository.

13. Click the "New pull request" button.

14. Select the branch you just pushed to and the branch you want to merge into on the original repository.

15. Add a description of your changes and click the "Create pull request" button.

16. Wait for the project maintainer to review your changes and provide feedback.

17. Make any necessary changes based on feedback and repeat steps 5-12 until your changes are accepted and merged into the main project.

18. Once your changes are merged, you can update your forked repository and local copy of the repository with the following commands:

git fetch upstream
git checkout master
git merge upstream/master

Finally, delete the branch you created with the following command:

git branch -d branch-name

That's it you made it 🐣⭐⭐