Skip to content

Instantly share code, notes, and snippets.

Embed
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.

Copy link

@olaoluwa-98 olaoluwa-98 commented Apr 7, 2017

This is very helpful

@HarshitKaushik

This comment has been minimized.

Copy link

@HarshitKaushik HarshitKaushik commented Apr 8, 2017

Very helpful for beginners, thank you.

@Jambazishvili

This comment has been minimized.

Copy link

@Jambazishvili Jambazishvili commented Jun 6, 2017

pretty helpful and nicely structured. thank you very much!

@dattz

This comment has been minimized.

Copy link

@dattz dattz commented Jun 20, 2017

Thank you.

@ryanrayjahn

This comment has been minimized.

Copy link

@ryanrayjahn ryanrayjahn commented Dec 23, 2017

Will try.

@Nikoloutsos

This comment has been minimized.

Copy link

@Nikoloutsos Nikoloutsos commented Jan 4, 2018

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

@StephRicardo

This comment has been minimized.

Copy link

@StephRicardo StephRicardo commented Jan 20, 2018

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

@CompSciGuyIT

This comment has been minimized.

Copy link

@CompSciGuyIT CompSciGuyIT commented Feb 22, 2018

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

@fost14oct-zz

This comment has been minimized.

Copy link

@fost14oct-zz fost14oct-zz commented Feb 22, 2018

Thank you :D

@zoldos

This comment has been minimized.

Copy link

@zoldos 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.

Copy link

@TirupathiAndroid TirupathiAndroid commented Apr 4, 2018

Thank you

@Krishna-Vyas

This comment has been minimized.

Copy link

@Krishna-Vyas Krishna-Vyas commented Apr 5, 2018

Thank you,, for your great response.

@shanky97

This comment has been minimized.

Copy link

@shanky97 shanky97 commented Apr 5, 2018

Thanks

@vicrobot

This comment has been minimized.

Copy link

@vicrobot vicrobot commented Apr 6, 2018

Great

@sayantanHack

This comment has been minimized.

Copy link

@sayantanHack sayantanHack commented Apr 10, 2018

sounds good

@haidaoxiaofei

This comment has been minimized.

Copy link

@haidaoxiaofei haidaoxiaofei commented May 21, 2018

just tried. Nice procedure.

@EigenLaw

This comment has been minimized.

Copy link

@EigenLaw EigenLaw commented Jun 6, 2018

Thanks very much!

@ArjunasarathyM

This comment has been minimized.

Copy link

@ArjunasarathyM ArjunasarathyM commented Jun 20, 2018

was really helpful :), Thank you

@pkoukia

This comment has been minimized.

Copy link

@pkoukia pkoukia commented Jul 8, 2018

Nice :)

@Joshua-Inman

This comment has been minimized.

Copy link

@Joshua-Inman Joshua-Inman commented Aug 1, 2018

Thank you!

@FrancoisT31

This comment has been minimized.

Copy link

@FrancoisT31 FrancoisT31 commented Sep 30, 2018

A big thank you for that !

@paddotk

This comment has been minimized.

Copy link

@paddotk paddotk commented Oct 8, 2018

Is there a reason for calling the remote upstream? origin seems the more obvious/default choice to me.

@sheikgit

This comment has been minimized.

Copy link

@sheikgit sheikgit commented Nov 12, 2018

Very helpful!!! Just submitted my first contribution!! :)

@iranappo

This comment has been minimized.

Copy link

@iranappo iranappo commented Nov 19, 2018

Thank you

@daisai3

This comment has been minimized.

Copy link

@daisai3 daisai3 commented Jan 6, 2019

Very helpful!
:)

@amintado

This comment has been minimized.

Copy link

@amintado amintado commented Jan 19, 2019

very helpfull!
nice

@Muniy90

This comment has been minimized.

Copy link

@Muniy90 Muniy90 commented Feb 8, 2019

May I know how this tool is different from Acunetix ? How credential scans can be made in this tool ?

@johngorithm

This comment has been minimized.

Copy link

@johngorithm johngorithm commented Feb 9, 2019

Nice one
Thanks a lot 👍

@nBhati

This comment has been minimized.

Copy link

@nBhati nBhati commented Mar 17, 2019

Thank you for the well written help.

@FirdausAbdRahman

This comment has been minimized.

Copy link

@FirdausAbdRahman FirdausAbdRahman commented Apr 11, 2019

very helpful. Thanks.

@lukepass

This comment has been minimized.

Copy link

@lukepass lukepass commented Jun 11, 2019

Thanks! About this:

If you created your fork a while ago be sure to pull upstream changes into your local repository.

How do I rebase work from the original repo if I contributed a while ago?

@adwaitmathkari

This comment has been minimized.

Copy link

@adwaitmathkari adwaitmathkari commented Jul 2, 2019

Thanks!

@kelanik8

This comment has been minimized.

Copy link

@kelanik8 kelanik8 commented Jul 26, 2019

Thanks

@SpiritS0uL90

This comment has been minimized.

Copy link

@SpiritS0uL90 SpiritS0uL90 commented Jul 27, 2019

@Olutobz

This comment has been minimized.

Copy link

@Olutobz Olutobz commented Aug 19, 2019

Thanks a lot, quite insightful

@killbotXD

This comment has been minimized.

Copy link

@killbotXD killbotXD commented Sep 20, 2019

thanks it was helpful.

@AurioPinto

This comment has been minimized.

Copy link

@AurioPinto AurioPinto commented Sep 24, 2019

A big thanks

@puppylpg

This comment has been minimized.

Copy link

@puppylpg puppylpg commented Nov 2, 2019

Thanks 👍

@raajtilaksarma

This comment has been minimized.

Copy link

@raajtilaksarma raajtilaksarma commented Feb 4, 2020

https://help.github.com/en/articles/interactive-rebase
^ This link is not opening. Do you have an alternate link for the same?

@georkings

This comment has been minimized.

Copy link

@georkings georkings commented Apr 24, 2020

@Kartik987

This comment has been minimized.

Copy link

@Kartik987 Kartik987 commented May 29, 2020

nice explanation

@Marrockx

This comment has been minimized.

Copy link

@Marrockx Marrockx commented Jun 3, 2020

Thanks for this info👍

@ghost

This comment has been minimized.

Copy link

@ghost ghost commented Jul 29, 2020

Thanks I am news here any ideas for basic web development to help with I know allot of HTML some PHP and JavaScript though I want to learn C++, python, Java, Go, Nim

@Loppy3232

This comment has been minimized.

Copy link

@Loppy3232 Loppy3232 commented Sep 8, 2020

Really helpful, thanks!

@Svastikkka

This comment has been minimized.

Copy link

@Svastikkka Svastikkka commented Sep 16, 2020

Thanks @MarcDiethelm

@fazil786-code

This comment has been minimized.

Copy link

@fazil786-code fazil786-code commented Sep 20, 2020

Exactly what I needed. Thanks!

@siva-sankaran

This comment has been minimized.

Copy link

@siva-sankaran siva-sankaran commented Oct 24, 2020

Why we need to fork the repo ? Why not just clone the repo, work on a new branch and after commit&push creating pull request ? Please help me to understand it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.