To contribute to this GitHub project, you can follow these steps:
-
Fork the repository you want to contribute to by clicking the "Fork" button on the project page.
-
Clone the repository to your local machine using the following command:
git clone https://github.com/<YOUR-GITHUB-USERNAME>/Awesome-Text2SQL
- Create a new branch for your changes using the following command:
git checkout -b "branch-name"
- Make your changes to the documentation.
- Example: Add more dataset or base model.
- Add the changes to the staging area using the following command:
git add .
- Commit the changes with a meaningful commit message using the following command:
git commit -m "your commit message"
- Push the changes to your forked repository using the following command:
git push origin branch-name
-
Go to the GitHub website and navigate to your forked repository.
-
Click the "New pull request" button.
-
Select the branch you just pushed to and the branch you want to merge into on the original repository.
-
Add a description of your changes and click the "Create pull request" button.
-
Wait for the project maintainer to review your changes and provide feedback.
-
Make any necessary changes based on feedback and repeat steps 4-10 until your changes are accepted and merged into the main project.
-
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 🐣⭐⭐