Skip to content

Commit

Permalink
Add a contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
danielgtaylor committed Nov 11, 2014
1 parent 2f90440 commit e3d291b
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
39 changes: 39 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
For more information, please see the official docs at
http://boto3.readthedocs.org/

Contributing Code
-----------------
A good pull request:

- Is clear.
- Works across all supported versions of Python.
- Follows the existing style of the code base (PEP-8).
- Has comments included as needed.

- A test case that demonstrates the previous flaw that now passes with
the included patch, or demonstrates the newly added feature.
- If it adds/changes a public API, it must also include documentation
for those changes.
- Must be appropriately licensed (Apache 2.0).

Reporting An Issue/Feature
--------------------------
First, check to see if there's an existing issue/pull request for the
bug/feature. All issues are at
https://github.com/boto/boto3/issues and pull reqs are at
https://github.com/boto/boto3/pulls.

If there isn't an existing issue there, please file an issue. The
ideal report includes:

- A description of the problem/suggestion.
- How to recreate the bug.
- If relevant, including the versions of your:

- Python interpreter
- Boto 3
- Optionally of the other dependencies involved (e.g. Botocore)

- If possible, create a pull request with a (failing) test case
demonstrating what's wrong. This makes the process for fixing bugs
quicker & gets issues resolved sooner.
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
include CONTRIBUTING.rst
include README.rst
include LICENSE
include requirements.txt
Expand Down

0 comments on commit e3d291b

Please sign in to comment.