If you have any doubt regarding how to contribution or anything else feel free to join our community and ask there!
-
Fork this repository.
-
Clone the forked repository.
bash
git clone https://github.com/<your-github-username>/project_name.git
- Navigate to the project directory.
bash
cd <folder-name>
- Creating a new branch (IMP) 🌱
This is one of the very important steps that you should follow to contribute to Open Source. A branch helps to manage the workflow, isolate your code and does not create a mess. To create a new branch:
bash
$ git branch <name_of_branch>
$ git checkout -b <name_of_branch>
Keep your cloned repo up to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)
bash
git pull origin main
-
Make changes in source code. 🚀
-
Stage your changes and commit 📝
bash
Add changes to Index
git add .
Commit to the local repo
git commit -m "<your_commit_message>"
- At this point you can use the git push command to push the changes to the current branch of your forked repository:
bash
git push origin <branch-name>
-
🛠 Create a Pull Request/PR!
-
Additional Steps (IMPORTANT)
If you are contributing to any of the following repositories:
Haystack
Hugging Face Hub
ML Algorithms
Matplotlib
MindsDB
Wiz-craft
scalarflow
Once your pull request is merged or accepted to hacktoberfest, append a link to your contribution along with your github id to the tracker.md file in the specific folders above. -
Congratulations! 🎉 Sit and relax, you've made your contribution to the AIML repository of GDSC Cummins under Hacktoberfest 2023. 🌟