[gentoo-commits] proj/sci:master commit in: /

[Sebastien Fabbro]

commit:     a3f4fd29d5d2b87b5bd04cb9d5ab57db266cc27d
Author:     Justin Lecher <jlec <AT> gentoo <DOT> org>
AuthorDate: Wed Jan 22 09:50:08 2014 +0000
Commit:     Sebastien Fabbro <bicatali <AT> gentoo <DOT> org>
CommitDate: Wed Jan 22 09:50:08 2014 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/sci.git;a=commit;h=a3f4fd29

For Contributors ready

Signed-off-by: Justin Lecher <jlec <AT> gentoo.org>

---
 CONTRIBUTING.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 63 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7579f6d..f4e7e95 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@×××××.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)
+
+![ccsa-4 icon](http://i.creativecommons.org/l/by-sa/4.0/88x31.png)
\ No newline at end of file