Skip to content

Latest commit

 

History

History
74 lines (62 loc) · 3.27 KB

CONTRIBUTING.rst

File metadata and controls

74 lines (62 loc) · 3.27 KB
Raw

Contributing

We work hard to provide a high-quality and useful SDK, and we greatly value feedback and contributions from our community. Whether it's a new feature, correction, or additional documentation, we welcome your pull requests. Please submit any issues or pull requests through GitHub.

This document contains guidelines for contributing code and filing issues.

Contributing Code

The list below are guidelines to use when submitting pull requests. These are the same set of guidelines that the core contributors use when submitting changes, and we ask the same of all community contributions as well:

  • The SDK is released under the Apache license. Any code you submit will be released under that license.

  • We maintain a high percentage of code coverage in our unit tests. As a general rule of thumb, code changes should not lower the overall code coverage percentage for the project. To help with this, we use coveralls, which will comment on changes in code coverage for every pull request. In practice, this means that every bug fix and feature addition should include unit tests.

  • We may choose not to accept pull requests that change the JSON service descriptions, such as botocore/data/aws/s3/2006-03-01/service-2.json and changes to any of the following files in botocore/data/:

    • _endpoints.json
    • *.paginators-1.json
    • *.waiters-2.json

    We generate these files upstream based on our internal knowledge of the AWS services. If there is something incorrect with or missing from these files, it may be more appropriate to submit an issue so we can get the issue fixed upstream. This constraint only applies to the above mentioned files. We do accept, and encourage, changes to the botocore/data/_retry.json file.

  • Code should follow pep 8, although if you are modifying an existing module, it is more important for the code to be consistent if there are any discrepancies.

  • Code must work on python2.7, and python3.6 and higher.

  • Botocore is cross platform and code must work on at least linux, Windows, and Mac OS X.

  • If you would like to implement support for a significant feature that is not yet available in botocore, please talk to us beforehand to avoid any duplication of effort. You can file an issue to discuss the feature request further.

Reporting An Issue/Feature

  • Check to see if there's an existing issue/pull request for the bug/feature. All issues are at https://github.com/boto/botocore/issues and pull reqs are at https://github.com/boto/botocore/pulls.
  • If there isn't an existing issue there, please file an issue. The ideal report includes:
    • A description of the problem/suggestion.
    • A code sample that demonstrates the issue.
    • Including the versions of your:
      • python interpreter
      • OS
      • botocore (accessible via botocore.__version__)
      • optionally any other python dependencies involved