Skip to content

Latest commit

 

History

History
92 lines (65 loc) · 3.36 KB

Contributing.md

File metadata and controls

92 lines (65 loc) · 3.36 KB
Raw

Contributing Guidelines

This Documentation contains a set of guidelines to help you during the contribution workflow. We are happy to welcome all the contributions from anyone willing to improve/add new features or resolve existing issues and bugs. Thank you for helping out and remember, no contribution is too small.

Steps to Follow for Contributing to this Project

Step 1 : Find an Issue

  • Go through the Existing Issues or create your own Issues!
  • Explain your Solution/Approach to resolve the selected issue to the Maintainer in the Issues Section.
  • Wait for the Issue to be assigned to you after which you can start working on it.

Step 2 : Fork and Clone the Project

  • Forking this Repo will create a Local copy of this project on Github.
  • After forking , clone the project to get a copy of the project in your local machine.

$ git clone https://github.com/<your-username>/Batua.git
$ cd Batua

Step 3 : Set a Remote to the Original Repo

  • Remotes are references to fetch or pull any recent changes in the original codebase to your copy of project.

$ git remote add upstream https://github.com/pratyushmp/Batua

Step 4 : Create a Branch

  • Its preffered to do all your work on a seperate branch , keeping the main branch clean.
$ git checkout -b branch_name

Step 5 : Start Working on the Issue assigned

  • Add all files/folders needed.
  • After making all changes/implementations add all those changes to the respective branch by :

$ git add .

Step 6 : Commit all Changes

  • Commit or save all those added changes with a convenient message so that reviewer can understand what changes you did.

$ git commit -m 'your-commit-message-here'

Step 7 : Push all Changes

  • After you are done with your contribution. Push all those changes to your Forked Repo on Github.

$ git push -u origin branch_name

Step 8 : Create a Pull Request

  • Go to your forked Repo in browser and click on compare and pull requests.

  • Add a title and description to your PR describing about your contribution.

  • Congratulations! Your PR has been submitted and will be reviewed by the maintainers and merged.

ADD A REMOTE (UPSTREAM) TO ORIGINAL PROJECT REPOSITORY

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.

SYNCHRONIZING YOUR FORK -

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.

SQUASHING YOUR COMMITS-

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.