Skip to content

Commit e3d291b

Browse files
committed
Add a contributing doc
1 parent 2f90440 commit e3d291b

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

CONTRIBUTING.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
For more information, please see the official docs at
2+
http://boto3.readthedocs.org/
3+
4+
Contributing Code
5+
-----------------
6+
A good pull request:
7+
8+
- Is clear.
9+
- Works across all supported versions of Python.
10+
- Follows the existing style of the code base (PEP-8).
11+
- Has comments included as needed.
12+
13+
- A test case that demonstrates the previous flaw that now passes with
14+
the included patch, or demonstrates the newly added feature.
15+
- If it adds/changes a public API, it must also include documentation
16+
for those changes.
17+
- Must be appropriately licensed (Apache 2.0).
18+
19+
Reporting An Issue/Feature
20+
--------------------------
21+
First, check to see if there's an existing issue/pull request for the
22+
bug/feature. All issues are at
23+
https://github.com/boto/boto3/issues and pull reqs are at
24+
https://github.com/boto/boto3/pulls.
25+
26+
If there isn't an existing issue there, please file an issue. The
27+
ideal report includes:
28+
29+
- A description of the problem/suggestion.
30+
- How to recreate the bug.
31+
- If relevant, including the versions of your:
32+
33+
- Python interpreter
34+
- Boto 3
35+
- Optionally of the other dependencies involved (e.g. Botocore)
36+
37+
- If possible, create a pull request with a (failing) test case
38+
demonstrating what's wrong. This makes the process for fixing bugs
39+
quicker & gets issues resolved sooner.

MANIFEST.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
include CONTRIBUTING.rst
12
include README.rst
23
include LICENSE
34
include requirements.txt

0 commit comments

Comments
 (0)