Skip to content

Latest commit

 

History

History
113 lines (70 loc) · 4.01 KB

CONTRIBUTING.md

File metadata and controls

113 lines (70 loc) · 4.01 KB
Raw

Contributing Guidelines

This documentation contains a set of guidelines to help you during the contribution process.

Submitting Contributions

Below you will find the process and workflow used to review and merge your changes.

Choose an issue/ Create an issue

  • Look for the existing issue or create your own issue.
  • Comment on the respective issue you would like to work on before creating a Pull Request.
  • Wait for the issue to be assigned to you after which you can start working on it.

Fork the repository

  • Fork this repository by clicking on the "Fork" button. This will create a local copy of this repository on your GitHub profile.

Clone the forked repository

  • Once the repository is forked you need to clone it to your local machine.
  • Click on the "Code" button on the repository page and copy the link provided in the dropdown menu.
git clone https://github.com/<your-username>/<repo-name>
  • Keep a reference to the original project in upstream remote.
cd <repo-name>  
git remote add upstream https://github.com/<upstream-owner>/<repo-name>
git remote -v # To the check the remotes for this repository
  • If the project is forked already, update the copy before working.
git remote update
git checkout <branch-name>
git rebase upstream/<branch-name>

Create a new branch

  • Always create a new branch and name it accordingly so as to identify the issue you are addressing.
# It will create a new branch with name branch_name and switch to that branch 
git checkout -b branch_name

Work on the issue assigned

  • Work on the issue(s) assigned to you, and make the necessary changes in the files/folders needed.
  • After making the changes add them to the branch you've created.
# To add all new files to branch Branch_Name  
git add .  

# To add only a few files to Branch_Name
git add <file name>

Commit the changes

  • Add your commits.
  • Along with the commit give a descriptive message that reflects your changes.
git commit -m "message"
  • Note: A Pull Request should always have only one commit.

Push the changes

  • Push the committed changes in your branch to your remote repository.
git push origin branch_name

Create a Pull Request

  • Go to your repository in the browser and click on compare and pull request.
  • Add a title and description to your pull request that best describes your contribution.
  • After which the pull request will be reviewed and the maintainer will provide the reviews required for the changes.

If no changes are needed, this means that your Pull Request has been reviewed and will be merged into the original code base by the maintainer.

Happy Hacking!

Additional Information

  • What is fork ?

A fork is a new repository that shares code and visibility settings with the original “upstream” repository. Forks are often used to iterate on ideas or changes before they are proposed back to the upstream repository, such as in open source projects or when a user does not have write access to the upstream repository.

  • What is an issue ?

An Issue in GitHub is a sort of bug tracker for a project which has its own section in every repository. It can be used for discussions which include a variety of things like reporting a bug on that repository, asking questions or even asking for a particular feature. It is a great place to keep a track of tasks and enhancements of the project. Being good at writing issues often helps in building better open source projects and will help other contributors to understand your project better and help you.

  • How to create an issue ?

To make a new issue in your repository, navigate to the repository where you want to raise an issue and go to the Issues tab.

  • What is pull request ?

A pull request is a request to merge changes from one branch to another, typically used for code review before merging.4 It is a mechanism for a developer to notify team members that they have completed a feature and file a pull request via their Bitbucket account.