|
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 <https: |
|
or `pull requests <https: |
|
|
|
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 <http: |
|
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 <https: |
|
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. |
|
* If you identify an issue with the JSON service descriptions, |
|
such as ``botocore/data/aws/s3/2006-03-01/service-2.json``, please submit an |
|
`issue <https: |
|
fixed upstream. |
|
* Changes to paginators, waiters, and endpoints are also generated upstream based on our internal knowledge of the AWS services. |
|
These include any of the following files in ``botocore/data/``: |
|
|
|
* ``_endpoints.json`` |
|
* ``*.paginators-1.json`` |
|
* ``*.waiters-2.json`` |
|
|
|
If you identify an issue with these files, such as a missing paginator or waiter, please submit an |
|
`issue <https: |
|
* We do accept, and encourage, changes to the ``botocore/data/_retry.json`` file. |
|
* Code should follow the guidelines listed in the Codestyle section below. |
|
* Code must work on all versions of Python supported by Botocore. |
|
* 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 <https: |
|
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: |
|
https: |
|
* 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 |
|
|
|
Codestyle |
|
--------- |
|
This project uses `ruff <https: |
|
codstyle requirements. We've codified this process using a tool called |
|
`pre-commit <https: |
|
config file with all tools required for code linting, and surfaces either a |
|
git commit hook, or single command, for enforcing these. |
|
|
|
To validate your PR prior to publishing, you can use the following |
|
`installation guide <https: |
|
|
|
If you don't want to use the git commit hook, you can run the below command |
|
to automatically perform the codestyle validation: |
|
|
|
.. code-block:: bash |
|
|
|
$ pre-commit run |
|
|
|
This will automatically perform simple updates (such as white space clean up) |
|
and provide a list of any failing checks. After these are addressed, |
|
you can commit the changes prior to publishing the PR. |
|
These checks are also included in our CI setup under the "Lint" workflow which |
|
will provide output on Github for anything missed locally. |
|
|