Create a gist now

Instantly share code, notes, and snippets.

What would you like to do?
How to contribute to a project on Github

This text now lives at https://github.com/MarcDiethelm/contributing/blob/master/README.md. I turned it into a Github repo so you can, you know, contribute to it by making pull requests.


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.
  • If you created your fork a while ago be sure to pull upstream changes into your local repository.
  • Create a new branch to work on! Branch from develop if it exists, else from master.
  • Implement/fix your feature, comment your code.
  • Follow the code style of the project, including indentation.
  • If the project has tests run them!
  • 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).

And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.

@olaoluwa-98

This comment has been minimized.

Show comment Hide comment
@olaoluwa-98

olaoluwa-98 Apr 7, 2017

This is very helpful

This is very helpful

@HarshitKaushik

This comment has been minimized.

Show comment Hide comment
@HarshitKaushik

HarshitKaushik Apr 8, 2017

Very helpful for beginners, thank you.

Very helpful for beginners, thank you.

@Jambazishvili

This comment has been minimized.

Show comment Hide comment
@Jambazishvili

Jambazishvili Jun 6, 2017

pretty helpful and nicely structured. thank you very much!

pretty helpful and nicely structured. thank you very much!

@dattz

This comment has been minimized.

Show comment Hide comment
@dattz

dattz Jun 20, 2017

Thank you.

dattz commented Jun 20, 2017

Thank you.

@ryanrayjahn

This comment has been minimized.

Show comment Hide comment
@ryanrayjahn

ryanrayjahn Dec 23, 2017

Will try.

Will try.

@arkoydas

This comment has been minimized.

Show comment Hide comment
@arkoydas

arkoydas Jan 4, 2018

Thank you for sharing this with us!
It helped me so much..

arkoydas commented Jan 4, 2018

Thank you for sharing this with us!
It helped me so much..

@StephRicardo

This comment has been minimized.

Show comment Hide comment
@StephRicardo

StephRicardo Jan 20, 2018

Thanks so much for this gist! It's excellent!

Thanks so much for this gist! It's excellent!

@CompSciGuyIT

This comment has been minimized.

Show comment Hide comment
@CompSciGuyIT

CompSciGuyIT Feb 22, 2018

Nice! This demystifies things quite a lot. Thank you.

Nice! This demystifies things quite a lot. Thank you.

@fost14oct

This comment has been minimized.

Show comment Hide comment
@fost14oct

fost14oct Feb 22, 2018

Thank you :D

Thank you :D

@zoldos

This comment has been minimized.

Show comment Hide comment
@zoldos

zoldos Feb 23, 2018

Seems a bit involved, but I'm ready to dive right in, esp. with PHP! 👍

zoldos commented Feb 23, 2018

Seems a bit involved, but I'm ready to dive right in, esp. with PHP! 👍

@TirupathiAndroid

This comment has been minimized.

Show comment Hide comment
@TirupathiAndroid

TirupathiAndroid Apr 4, 2018

Thank you

Thank you

@Krishna-Vyas

This comment has been minimized.

Show comment Hide comment
@Krishna-Vyas

Krishna-Vyas Apr 5, 2018

Thank you,, for your great response.

Thank you,, for your great response.

@shanky97

This comment has been minimized.

Show comment Hide comment
@shanky97

shanky97 Apr 5, 2018

Thanks

shanky97 commented Apr 5, 2018

Thanks

@vicrobot

This comment has been minimized.

Show comment Hide comment
@vicrobot

vicrobot Apr 6, 2018

Great

vicrobot commented Apr 6, 2018

Great

@sayantanHack

This comment has been minimized.

Show comment Hide comment
@sayantanHack

sayantanHack Apr 10, 2018

sounds good

sounds good

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment