blob: 3d02fa6ad60d32c72d761d6ec29c50037c998a3d (plain
#Contributions to the Gentoo Science Overlay
* **Account at [github](https://github.com/join)**
Everybody who wants to contribute needs to own an account. Please register yourself there.
* **Define echangelog user**
Make sure the ECHANGELOG_USER variable is present in your environment.
echo 'export ECHANGELOG_USER="John Smith <firstname.lastname@example.org>"' >> ~/.bashrc
* **Setup commit signing**
Create a [gpg key](http://www.gossamer-threads.com/lists/gentoo/dev/268496?do=post_view_threaded) if you don't have one already and make git use it.
git config --global user.signingkey <gpg-key-id>
* **Install [hub](http://hub.github.com/)**, the "command-line wrapper for git that makes you better at GitHub".
This file will use *hub* because of it's convenience when working with github.
First clone the overlay
hub clone gentoo-science/sci
In order to send pull request and ask for inclusion of your changes you need to have your own fork of the overlay on github. You can do this by issuing
Now you are ready to start your work.
It is always convenient for development as well as for the review and merging process, if the development is done in branches.
git checkout -b my-feature master
Now you can work on you package of interest. Once you are finished you should _always_ use **[repoman](http://dev.gentoo.org/~zmedico/portage/doc/man/repoman.1.html)** to check, verify and commit your changes.
Static analysis can be done with
Once *all* reported problems are resolved, you can commit it
echangelog "Here we write a comprehensible ChangeLog message"
repoman -m "Here we write a comprehensible commit message" commit
Next we push back the changes to our fork and send a pull-request to the overlay maintainers.
hub push YOUR_GITHUB_USER
Lastly you need to wait for review comments and the merge of your work. In case you need to include some improvements, just commit your work again using repoman and push it again to your fork. No need to send another pull-request as you new changes will be added the original one.
**The merging of pull request should only be done by gentoo developers!**
If you feel that they are slacking, don't bother to ping them again. If you like to become a dev yourself, prove some contribution and ping us via email@example.com or on irc in #gentoo-science @ freenode.
Make sure you have both repos (github & gentoo.org) as remotes defined.
git remote -v
>github firstname.lastname@example.org:gentoo-science/sci.git (fetch)
>github email@example.com:gentoo-science/sci.git (push)
>origin git+ssh://firstname.lastname@example.org/proj/sci.git (fetch)
>origin git+ssh://email@example.com/proj/sci.git (push)
In the beginning you should review the pull request on github directly and recommend as much improvements as possible. Once everything is fine or you like to fix the rest yourself, simply can use the follow command to get the pull-request in a new branch in you repo.
hub checkout https://github.com/gentoo-science/sci/pull/PULLREQUEST-NUMBER
Now check the package by building and installing it, and run *repoman* in the package dir. If this is also fine, merge the branch into the master
git checkout master
git merge USER-BRANCH
Finally use the script **merge-dualHEAD** from the *scripts* directory to merge the github and gentoo.org remote repo.
####Contribution to the document
Justin Lecher <firstname.lastname@example.org>
This document is available under [Creative Commons Attribution ShareAlike 4.0](http://creativecommons.org/licenses/by-sa/4.0)