Permalink
Browse files

Add AUTHORS.rst & CONTRIBUTING.md

The former to give credit where credit is due, the latter to ease contributing.
It's markdown instead of rst, because github supports that automatically[1].

[1]: https://github.com/blog/1184-contributing-guidelines
  • Loading branch information...
1 parent 191b817 commit 37d1a35044aca8211a53af27c63d36330c663f62 @hynek committed Oct 12, 2012
Showing with 30 additions and 1 deletion.
  1. +8 −0 AUTHORS.rst
  2. +20 −0 CONTRIBUTING.md
  3. +2 −1 setup.py
View
@@ -0,0 +1,8 @@
+Credits
+=======
+
+“first” is written and maintained by Hynek Schlawack and various contributors:
+
+- Łukasz Langa
+- Nick Coghlan
+- Vincent Driessen
View
@@ -0,0 +1,20 @@
+# How To Contribute
+
+Although very small, “first” is always open for suggestions and contributions
+by generous developers. I’ve collected a few tipps to get you started.
+
+Please:
+
+- Obey [PEP 8] and [PEP 257].
+- *Always* add tests and docs for your code.
+- Add yourself to the AUTHORS.rst file in an alphabetical fashion.
+- Write [good commit messages].
+- Ideally, [squash] your commits, i.e. make your pull requests just one commit.
+
+Thank you for considering to contribute to “first”!
+
+
+[squash]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
+[PEP 8]: http://www.python.org/dev/peps/pep-0008/
+[PEP 257]: http://www.python.org/dev/peps/pep-0257/
+[good commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
View
@@ -8,7 +8,8 @@
version=first.__version__,
description='Return the first true value of an iterable.',
long_description=(open('README.rst').read() + '\n\n' +
- open('HISTORY.rst').read()),
+ open('HISTORY.rst').read() + '\n\n' +
+ open('AUTHORS.rst').read()),
url='http://github.com/hynek/first/',
license=first.__license__,
author=first.__author__,

0 comments on commit 37d1a35

Please sign in to comment.