Skip to content

Commit f04d274

Browse files
author
BenjamenMeyer
committed
Enhancement: Added additional project documentation
- Added CONTRIBUTING.rst so people know how to help out - Added AUTHORS so everyone can be appropriately recognized
1 parent dccdcdb commit f04d274

2 files changed

Lines changed: 104 additions & 0 deletions

File tree

AUTHORS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* Benjamen R. Meyer (BenjamenMeyer)
2+

CONTRIBUTING.rst

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
**********************
2+
Contributors, Welcome!
3+
**********************
4+
5+
Come on in and contribute! StackInABox is looking to grow, and
6+
it needs your help. This document is a guide to making **really**
7+
successful contributions.
8+
9+
**Table of Contents**
10+
11+
.. contents::
12+
:local:
13+
:depth: 2
14+
:backlinks: none
15+
16+
=======================
17+
A Little Bit of Process
18+
=======================
19+
20+
----------------
21+
We've Got Issues
22+
----------------
23+
24+
Check out the `Issues`_ and `Milestones`_ tabs. They offer great
25+
starting points for making an effective contribution. If you find an
26+
issue or think of something that you'd like to see in the stack, the
27+
`Issues`_ page is the place to put it.
28+
29+
Feedback counts as a contribution, too, and it's the easiest one you
30+
can make.
31+
32+
-------
33+
Reviews
34+
-------
35+
36+
Except for feedback, every contribution begins with a pull request. In
37+
order to keep knowledge of StackInABox distributed, we encourage
38+
code review here.
39+
40+
-------
41+
Testing
42+
-------
43+
44+
We are aiming for 100% unit test coverage. Presently we have about 74%
45+
coverage. Once 100% test coverage is achieved then it will be required -
46+
no questions asked. Until then, please help us achieve that or at a minimum
47+
maintain the status quo.
48+
49+
To be clear about definitions, a unit test is one that:
50+
51+
* Tests expected functionality
52+
* Does not utilize unpredictable functionality (e.g., time.time)
53+
54+
To run tests::
55+
56+
tox
57+
58+
====
59+
Code
60+
====
61+
62+
Please keep all work in a branch. This makes it easy to add/remove changes
63+
and track the history.
64+
65+
-----
66+
Style
67+
-----
68+
69+
To be sure your contributions are compliant::
70+
71+
tox -e pep8
72+
73+
-----
74+
Misc.
75+
-----
76+
77+
Here are the tenants in order of importance:
78+
79+
* Correctness - incorrect code is useless
80+
* Simplicity - easy to use, easy to understand
81+
* Consistentency - new interfaces should feel like existing interfaces
82+
* Easy of use - users will only use it if it's easy and not burdensome
83+
* Performance - almost doesn't matter. "Optimization is the root of all evil".
84+
- Address performance when it becomes a problem. Don't make it a
85+
problem before it is.
86+
* Few dependencies - must be simple, explicit and not require a lot of things to be installed
87+
- Reduces the potential for issues with other projects
88+
- Keeps the ability to integrate into other projects high
89+
90+
=======
91+
Goodies
92+
=======
93+
94+
Make a successful contribution, and your name will be immortalized in
95+
the `AUTHORS`_ file! Thanks for your help. You make this project
96+
possible.
97+
98+
.. _Issues: https://github.com/BenjamenMeyer/stackInABox/issues
99+
.. _Milestones: https://github.com/BenjamenMeyer/stackInABox/milestones
100+
.. _pep8: https://pypi.python.org/pypi/pep8
101+
.. _AUTHORS: https://github.com/BenjamenMeyer/stackInABox/blob/master/AUTHORS
102+

0 commit comments

Comments
 (0)