commit: 0bd60f182f3614ae8f4401ca47ad01bdf19d294b
Author: David Seifert <soap <AT> gentoo <DOT> org>
AuthorDate: Fri Jan 22 07:49:24 2016 +0000
Commit: Justin Lecher <jlec <AT> gentoo <DOT> org>
CommitDate: Fri Jan 22 07:49:24 2016 +0000
URL: https://gitweb.gentoo.org/proj/sci.git/commit/?id=0bd60f18
Update contributing guidelines to match main Gentoo workflow
CONTRIBUTING.md | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 99561d0..f5e81b0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -83,6 +83,10 @@ 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
+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
+
Next we push back the changes in the PACKAGE_NAME branch to our fork and send
a pull-request to the overlay maintainers.
hub push YOUR_GITHUB_USER PACKAGE_NAME
@@ -94,6 +98,13 @@ Lastly you need to wait for review comments and the merge of
your work. If you f
If you would like to get direct access to the overlay, prove some contribution
and ping us via s...@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
+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
**It is important, that if you merge a pull request, you should feel as
responsible as if you have written the commits yourself!**
