-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enhancement: Added additional project documentation
- Added CONTRIBUTING.rst so people know how to help out - Added AUTHORS so everyone can be appropriately recognized
- Loading branch information
BenjamenMeyer
committed
Mar 6, 2015
1 parent
dccdcdb
commit f04d274
Showing
2 changed files
with
104 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
* Benjamen R. Meyer (BenjamenMeyer) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
********************** | ||
Contributors, Welcome! | ||
********************** | ||
|
||
Come on in and contribute! StackInABox is looking to grow, and | ||
it needs your help. This document is a guide to making **really** | ||
successful contributions. | ||
|
||
**Table of Contents** | ||
|
||
.. contents:: | ||
:local: | ||
:depth: 2 | ||
:backlinks: none | ||
|
||
======================= | ||
A Little Bit of Process | ||
======================= | ||
|
||
---------------- | ||
We've Got Issues | ||
---------------- | ||
|
||
Check out the `Issues`_ and `Milestones`_ tabs. They offer great | ||
starting points for making an effective contribution. If you find an | ||
issue or think of something that you'd like to see in the stack, the | ||
`Issues`_ page is the place to put it. | ||
|
||
Feedback counts as a contribution, too, and it's the easiest one you | ||
can make. | ||
|
||
------- | ||
Reviews | ||
------- | ||
|
||
Except for feedback, every contribution begins with a pull request. In | ||
order to keep knowledge of StackInABox distributed, we encourage | ||
code review here. | ||
|
||
------- | ||
Testing | ||
------- | ||
|
||
We are aiming for 100% unit test coverage. Presently we have about 74% | ||
coverage. Once 100% test coverage is achieved then it will be required - | ||
no questions asked. Until then, please help us achieve that or at a minimum | ||
maintain the status quo. | ||
|
||
To be clear about definitions, a unit test is one that: | ||
|
||
* Tests expected functionality | ||
* Does not utilize unpredictable functionality (e.g., time.time) | ||
|
||
To run tests:: | ||
|
||
tox | ||
|
||
==== | ||
Code | ||
==== | ||
|
||
Please keep all work in a branch. This makes it easy to add/remove changes | ||
and track the history. | ||
|
||
----- | ||
Style | ||
----- | ||
|
||
To be sure your contributions are compliant:: | ||
|
||
tox -e pep8 | ||
|
||
----- | ||
Misc. | ||
----- | ||
|
||
Here are the tenants in order of importance: | ||
|
||
* Correctness - incorrect code is useless | ||
* Simplicity - easy to use, easy to understand | ||
* Consistentency - new interfaces should feel like existing interfaces | ||
* Easy of use - users will only use it if it's easy and not burdensome | ||
* Performance - almost doesn't matter. "Optimization is the root of all evil". | ||
- Address performance when it becomes a problem. Don't make it a | ||
problem before it is. | ||
* Few dependencies - must be simple, explicit and not require a lot of things to be installed | ||
- Reduces the potential for issues with other projects | ||
- Keeps the ability to integrate into other projects high | ||
|
||
======= | ||
Goodies | ||
======= | ||
|
||
Make a successful contribution, and your name will be immortalized in | ||
the `AUTHORS`_ file! Thanks for your help. You make this project | ||
possible. | ||
|
||
.. _Issues: https://github.com/BenjamenMeyer/stackInABox/issues | ||
.. _Milestones: https://github.com/BenjamenMeyer/stackInABox/milestones | ||
.. _pep8: https://pypi.python.org/pypi/pep8 | ||
.. _AUTHORS: https://github.com/BenjamenMeyer/stackInABox/blob/master/AUTHORS | ||
|