Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:
If you don't have git on your machine, install it.
- Take a look at the Existing Issues or create your own Issues!
- Wait for the Issue to be assigned to you after which you can start working on it.
- Fork the Repo and create a Branch for any Issue that you are working upon.
- Read the Code of Conduct
- Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
- Add Screenshots to help us know what this Script is all about.
1. Fork this repository.
Click on the 
2. Clone the forked repository. Open terminal and type:
git clone https://github.com/<your-github-username>/Operationalizing-ML.git3. Navigate to the project directory.
cd Operationalizing-ML 4. Make a feature branch
git checkout -b <branch-name>
5. Make changes in source code/ project.
6. Stage your changes and commit
#Add changes to Index
git add .
#Commit to the local repo
git commit -m "<your_commit_message>"7. Push your local commits to the remote repo.
git push origin <brach-name>8. Create a PR !
9. Congratulations! Sit and relax, you've made your contribution to Operationalizing-ML project.
🏆 After this, project leaders and mentors will review the changes and will merge your PR if they are found good, otherwise we will suggest the required changes.
Remote means the remote location of project on Github. By cloning, we have a remote called origin which points to your forked repository. Now we will add a remote to the original repository from where we had forked.
$ cd <your-forked-project-folder>
$ git remote add upstream https://github.com/<author-account-username>/<project>.git
You will see the benefits of adding remote later.
Open Source projects have a number of contributors who can push code anytime. So it is necessary to make your forked copy equal with the original repository. The remote added above called Upstream helps in this.
$ git checkout master
$ git fetch upstream
$ git merge upstream/master
$ git push origin master
The last command pushes the latest code to your forked repository on Github. The origin is the remote pointing to your forked repository on github.
You have completed the feature, but you have made a number of commits which make less sense. You should squash your commits to make good commits.
$ git rebase -i HEAD~5
This will open an editor which will allow you to squash the commits.
- Use the present tense (example: "Add feature" and not "Added feature")
- Use the imperative mood (example: "Move item to...", instead of "Moves item to...")
- Limit the first line (also called subject line) to 50 characters or less
- Capitalize the subject line
- Separate subject from body with a blank line
- Do not end the subject line with a period
- Wrap the body at 72 characters
- Use the body to explain what, why, vs, and how
- Reference issues and pull requests liberally after the first line
For more detailed reference to the above points, refer here: https://chris.beams.io/posts/git-commit.
For major changes, you are welcomed to open an issue about what you would like to contribute. Enhancements will be appreciated.
