Contributing via pull requests
Opening issues for an application at github, for example, is a good way to help improving software. Often it's only a small detail and something a non-programming user could easily fix. Maybe it's just a typo or improved documentation etc.
Doing the changes yourself and contributing these fixes directly via a so-called "pull-request" is even better, as it saves the precious time of the developers/maintainers. Also, this dabbling in code might be a nice way to slowly ease yourself into more ambitious contributions.
In this post, I'd like to give a small step-by-step introduction how to contribute via pull-requests with an example of a recipe in haikuports. I'm in no way an experienced user of git etc., so I appreciate improvements in the comments. Just remember, we want to keep it very simple... :)
These are the steps for a pull request:
- Create a user at github.
- Create a fork of the project.
- Clone that forked project.
- Make your changes to the code, test and commit them.
- Push your changes to your forked project.
- Create a pull-request
1. Create a user at github
That one should be obvious...
2. Create a fork of the project
Go to the haikuports project and click the "Fork" button at the top right of the page. Now go to your personal github and you'll find the forked repo there.
3. Clone that forked project
On that page of your fork, click the "Clone or download" button and copy the web URL "https://github.com/humdingerb/haikuports.git". Now open a Terminal, change into the folder you want to put the code and clone your fork (i.e. download the code):
cd /boot/home git clone https://github.com/humdingerb/haikuports.git
Getting the whole haikuports tree takes a while...
4. Make your code changes
Now do those changes you wanted to do. Maybe it was simply a typo in a recipe description. After all is done and you checked if haikuporter can still build the package. You check once more your changes to make sure you didn't change more than intended:
This shows the differences compared to the original files. If that's OK, you commit them all with:
git commit -a
A text editor opens for you to enter a descriptive commit message, e.g. "Recipe XY: fixed typo in description".
Now, what if after that commit you realize that there was another typo, or you made a typo when correcting the typo, or something equally tautologically embarrassing?
Easy, just make your changes and then amend those changes when committing again with:
git commit -a -amend
That way, you'll still only have one commit when you're finally pushing it to your repo. You can do this as often as you have to...
5. Push your changes
You push those changes to your github with:
6. Create a pull-request
Now open your forked project at github in the webbrowser. At the top you click the button "New pull request" which will take you through the steps of submitting your changes to the haikuports project.
If they accept your request, they pull your changes into their master branch and you're all done.
Often however, the developer/maintainer of the project has a few details to nag about. No problem, just make those additional changes to the code and again amend those with:
git commit -a -amend
To update the existing pull-request, you have to "force" the push with:
git push -f
And that's all there is to it. Really quite easy in its simplest form, isn't it? Of course, things can get a bit more complicated (but also more sophisticated) when using branches and remote repos, and even more complicated when you've messed up your commits and have to get it all back on track... :)
Don't let that discourage you, though. Open the Vision app and join the #haiku channel on IRC to get help, consult the haikuports wiki, and always keep in mind the xkcd wisdom:
- Haiku monthly activity report - 03/2018
- Haiku monthly activity report - 02/2018
- Haiku monthly activity report - 01/2018
- GCI 2017 Wrap Up Report
- Haiku monthly activity report - 12/2017
- New package repositories are now enabled by default
- Haiku monthly activity report - 11/2017
- Scripting the GUI with 'hey'
- Haiku monthly activity report - 10/2017
- Back from GSoC mentor summit