diff options
| author |   Justin Lecher <jlec@gentoo.org> | 2014-01-22 10:50:08 +0100 |
|---|---|---|
| committer | Justin Lecher <jlec@gentoo.org> | 2014-01-22 10:50:08 +0100 |
| commit | a3f4fd29d5d2b87b5bd04cb9d5ab57db266cc27d (patch) | |
| tree | 2015ab38d64fdf83c36c7648f1463400c13c5112 | |
| parent | Add initial contribution FAQ (diff) | |
| download | sci-a3f4fd29d5d2b87b5bd04cb9d5ab57db266cc27d.tar.gz sci-a3f4fd29d5d2b87b5bd04cb9d5ab57db266cc27d.tar.bz2 sci-a3f4fd29d5d2b87b5bd04cb9d5ab57db266cc27d.zip | |
For Contributors ready
Signed-off-by: Justin Lecher <jlec@gentoo.org>
| -rw-r--r-- | CONTRIBUTING.md | 65 |
1 files changed, 63 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7579f6dba..f4e7e95f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,68 @@ #Contributions to the Gentoo Science Overlay +---- ##Prerequisite -###For Contributors +###Requiered -###For Maintainers +* Everybody who wants to contribute should own an account at [github](https://github.com/join). Please register yourself there. + +###Recommended +* **Define echangelog user** + +Make sure the ECHANGELOG_USER variable is present in your environment. + + echo 'export ECHANGELOG_USER="John Smith <john@smith.com>"' >> ~/.bashrc + +###Optional +* **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. + + emerge dev-vcs/hub + + +---- +##For Contributors + + +First clone the overlay + + hub clone gentoo-science/sci + + + cd sci + + +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 + + repoman full + +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 + + + +---- +##For Maintainers + + +--- +This document is available under [Creative Commons Attribution ShareAlike 4.0](http://creativecommons.org/licenses/by-sa/4.0) + +
\ No newline at end of file |