diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000000..8df9c42719 --- /dev/null +++ b/CONTRIBUTING.rst @@ -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. diff --git a/MANIFEST.in b/MANIFEST.in index cc3ac24433..5133aa06df 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,4 @@ +include CONTRIBUTING.rst include README.rst include LICENSE include requirements.txt