Skip to content

Instantly share code, notes, and snippets.

@hengkiardo

hengkiardo/Contributing.md

Forked from MarcDiethelm/Contributing.md
Created November 21, 2013 09:42
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save hengkiardo/7578754 to your computer and use it in GitHub Desktop.
Save hengkiardo/7578754 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Contributing.md

Contributing

If you want to contribute to a project and make it better, your help is very welcome. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.

How to make a clean pull request

Look for a project's contribution instructions. If there are any, follow them.

  • Create a personal fork of the project on Github.
  • Clone the fork on your local machine. Your remote repo on Github is called origin.
  • Add the original repository as a remote called upstream.
  • Create a new branch to work on!
  • Implement/fix your feature, comment your code.
  • Follow the code style of the project, including indentation.
  • Write or adapt tests as needed.
  • Add or change the documentation as needed.
  • Squash your commits into a single commit with git's interactive rebase. Create a new branch if necessary.
  • Push your branch to your fork on Github, the remote origin.
  • From your fork open a pull request in the correct branch. Target the project's develop branch if there is one, else go for master!
  • ...
  • Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch(es).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment