aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CONTRIBUTING.md44
-rw-r--r--README.md2
2 files changed, 23 insertions, 23 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f5e81b04d..6c4ba5879 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,12 +1,12 @@
-#Contributions to the Gentoo Science Overlay
+# Contributions to the Gentoo Science Overlay
This guide summarizes the contribution and merging procedures for the Gentoo Science overlay on Github. For more information please visit the [Science Project page](https://wiki.gentoo.org/wiki/Project:Science/Contributing) in the [Gentoo wiki](https://wiki.gentoo.org/).
----
-##Prerequisite
+## Prerequisite
For the most convenient way to work with the overlay you should fulfill all prerequisites.
-###Required
+### Required
* **Install git**
@@ -20,14 +20,14 @@ Familiarize yourself with git and visit [http://git-scm.com/documentation](http:
Everybody who wants to contribute needs to own an account @ [Github](http://github.com/). Please register yourself [there](https://github.com/join).
-###Recommended
+### Recommended
* **Define the echangelog user**
Make sure the ECHANGELOG_USER variable is present in your environment.
echo 'export ECHANGELOG_USER="John Smith <john@smith.com>"' >> ~/.bashrc
-###Optional
+### 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.
@@ -49,40 +49,40 @@ Now git will sign your commits to the overlay by using the gpg key.
emerge app-portage/repo-commit
---
-##Contributing ebuilds
+## Contributing ebuilds
-###Clone the overlay
+### Clone the overlay
Create a local checkout of the overlay
hub clone gentoo-science/sci
-###Fork the overlay
+### Fork the overlay
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
cd sci
hub fork
-###Branch out for contribution
+### Branch out for contribution
It is always convenient for development as well as for the review and merging process, if the development is done in branches. Let's branch the overlay into a local branch named PACKAGE_NAME.
git checkout -b PACKAGE_NAME master
For the fastest process during merging it is best to have a single branch per package.
-###Work on the package
+### Work on the package
Now you are ready to work on your package of interest. Once you are finished you should _always_ use **[repoman](http://dev.gentoo.org/~zmedico/portage/doc/man/repoman.1.html)** to do a static analysis of your work.
This can be done with
repoman full
-###Commit your work
+### Commit your work
Once *all* reported problems are resolved, you can commit it
repo-commit "Here we write a comprehensible commit message"
-###Push to Github and make a pull request
+### Push to Github and make a pull request
In order to facilitate potential reverts of mistakes, we prefer to keep the git history as linear as possible. For this, always rebase your changes on the latest remote changes.
hub pull --rebase=preserve github master
@@ -94,24 +94,24 @@ Next we push back the changes in the PACKAGE_NAME branch to our fork and send a
Lastly you need to wait for review comments and the merge of your work. If you feel that they are slacking, don't bother to ping them again. In case you need to include some improvements, just commit your work again using *repo-commit* and push it again to your fork. No need to send another pull-request as your new changes will be added to the original one.
-###What's next?
+### What's next?
If you would like to get direct access to the overlay, prove some contribution and ping us via sci@gentoo.org or on irc in #gentoo-science @ freenode. If you would like to become a dev yourself, prove some more contributions and again, contact us. We are always looking for new candidates.
----
-##Ebuild recommendations
+## Ebuild recommendations
As the Gentoo Science overlay is a constant work-in-progress, we have some recommendations for prospective contributors:
* **Aim for writing EAPI=6 ebuilds.** For certain eclasses, EAPI=6 is not allowed yet. In such cases you may use EAPI=5. We will not accept EAPI<5 ebuilds.
* **Version bumps should always follow the latest guidelines.** For instance, a version bump of an ebuild that still employs autotools-utils.eclass should be avoided. Instead, drop 'autotools-utils', move to 'autotools' and call `default` followed by `eautoreconf` in src_prepare().
----
-##Merging contributions
+## Merging contributions
**It is important, that if you merge a pull request, you should feel as responsible as if you have written the commits yourself!**
-###Prerequisite
+### Prerequisite
Make sure you have both repos (github & gentoo.org) as remotes defined.
@@ -128,30 +128,30 @@ should give
>origin git+ssh://git@git.overlays.gentoo.org/proj/sci.git (push)
-###Review process
+### Review process
In the beginning you should review the pull request on github directly and recommend as much improvements as possible. By this you train the new contributor towards becoming a new dev, which should be our final goal.
-####Checking out the pull-request as local branch
+#### Checking out the pull-request as local branch
Once everything is fine or you like to fix the rest yourself, simply use the following command to get the pull-request in a new branch in your repo.
hub checkout https://github.com/gentoo-science/sci/pull/PULLREQUEST-NUMBER
-####Testing and repoman check
+#### Testing and repoman check
Now check the package by building and installing it, and run *repoman* in the package dir. Remember, when merging a pull request you take the responsibility for the quality of the commit.
-####Merge the pull-request branch into master
+#### Merge the pull-request branch into master
If this is also fine, merge the branch into the master
git checkout master
git merge USER-BRANCH
-####Merging the two remote HEADs
+#### Merging the two remote HEADs
Finally use the script **merge-dualHEAD** from the *scripts* directory to merge the github and gentoo.org remote repo.
---
-####Contribution to the document
+#### Contribution to the document
Sebastien Fabbro <bicatali@gentoo.org>
Justin Lecher <jlec@gentoo.org>
diff --git a/README.md b/README.md
index 2ff12d591..92f296e89 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-#Gentoo Science Overlay
+# Gentoo Science Overlay
An overlay for Gentoo, geared towards scientific packages.