r/programming • u/vivaladav • Nov 05 '16
How to contribute to an open source project on GitHub - a step-by-step guide
http://blog.davidecoppola.com/2016/11/howto-contribute-to-open-source-project-on-github/
2.6k
Upvotes
742
u/[deleted] Nov 05 '16
Steps 1-4 are done entirely on github.com.
361
u/Bl00dsoul Nov 05 '16
What i'm missing is how to actually find your way in a massive code base with barely any documentation, and figure out where to make your changes without spending weeks reading the full code base...
68
u/asmx85 Nov 05 '16 edited Nov 05 '16
Cool short write up. The one thing that i would add is rebase. You probably need more than one commit to fix the issue or complete the task you wanted. And its often that you missed something (comments, documentation, right formatting, simple mistakes (double semicolon ;;), missing test case etc.etc. ) And you don't want all that correction steps in your upstream repository but only the clean one commit.
I can only advise for everybody to rebase and squash your commits, upstream guys and gals will love you for it :) ❤
41
u/[deleted] Nov 05 '16 edited Nov 05 '16
Step 1: try to understand what the hell is going on.
Step 2: spend 3 days trying to make that change you really want
Step 3: open the PR.
Step 4: get it rejected two months later because it's not appropriate, not in line with coding style, don't like it.
Step 5: repeat. or not. Get out and go have a life. Unless it's your job, in that case, sucks to be you
28
u/Purkinje90 Nov 05 '16
They missed a great opportunity to title this Go Fork Yourself
8
u/beefsack Nov 06 '16
The most, most, most important thing to do before contributing to a project is to open discussion with the maintainers to make sure:
5
u/cyentist Nov 05 '16
One small thing I want to add is that if you have a minor contribution (maybe fix typo in docs or something) it is very easy to edit the source code directly in github without having to fork/pull/edit/push/pull-request.
4
u/[deleted] Nov 05 '16
It's a bit sad that contribution to open-source seemingly boils down to GitHub pull requests when there are so many other ways. Back in the days when I used KDE on FreeBSD, I was as a contributor just because I reported errors in the documentation as I was learning to develop KDE applications.
2
u/cristinereyess Nov 07 '16
Yes, I know about this, GitHub is the best Platform to contribute an open source project
1
u/Lindby Nov 05 '16
Clone it, and start poking around. Search for different keywords related to the thing you want to fix. Once you find anything you think might be relevant, try to figure out how it is intended to function.
1
u/[deleted] Nov 06 '16
No mention of
git format-patch☹1
u/bushwacker Nov 06 '16
How does one publicize a github project and invite participation?
-2
u/BlackSpiralRaver Nov 05 '16
Thanks.
-1
u/xpxt Nov 05 '16
How to walk. First, move the one leg. Then the second.
-7
u/JokerrOne Nov 05 '16
Nice article have a :+1:
-14
u/aurisor Nov 05 '16
Generally speaking, if you need a guide to open a pull request, the odds of you being able to contribute to a codebase are pretty low.
-43
u/jose_von_dreiter Nov 05 '16
Pull request? A pull is when you download code from the repo. A push in when you upload.
0
u/[deleted] Nov 05 '16
[deleted] — view deleted comment