Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

75 lines (51 loc) · 3.26 KB
Raw

Contributing to the Dropbox SDK for Python

We value and rely on the feedback from our community. This comes in the form of bug reports, feature requests, and general guidance. We welcome your issues and pull requests and try our hardest to be timely in both response and resolution. Please read through this document before submitting issues or pull requests to ensure we have the necessary information to help you resolve your issue.

Filing Bug Reports

You can file a bug report on the GitHub Issues page.

  1. Search through existing issues to ensure that your issue has not been reported. If it is a common issue, there is likely already an issue.

  2. Please ensure you are using the latest version of the SDK. While this may be a valid issue, we only will fix bugs affecting the latest version and your bug may have been fixed in a newer version.

  3. Provide as much information as you can regarding the language version, SDK version, and any other relevant information about your environment so we can help resolve the issue as quickly as possible.

Submitting Pull Requests

We are more than happy to recieve pull requests helping us improve the state of our SDK. You can open a new pull request on the GitHub Pull Requests page.

  1. Please ensure that you have read the License, Code of Conduct and have signed the Contributing License Agreement (CLA).

  2. Please add tests confirming the new functionality works. Pull requests will not be merged without passing continuous integration tests unless the pull requests aims to fix existing issues with these tests.

Updating Generated Code

Generated code can be updated by running the following code:

$ pip install -r requirements.txt
$ git submodule init
$ git submodule update --remote --recursive
$ python generate_base_client.py

Note: Stone updates must be made by updating requirements.txt as it is no longer a submodule.

Testing the Code

We use the tox package to run tests. To install and run the unit tests, you can use:

$ pip install tox
$ tox

Or if you would like to specify a specific target to run you can run this:

$ tox -e {TARGET}

If you want to run the integration tests, you can use the following:

$ export DROPBOX_REFRESH_TOKEN={fill in refresh token}
$ export DROPBOX_APP_KEY={fill in app key}
$ export DROPBOX_APP_SECRET={fill in app secret}
$ export DROPBOX_TEAM_TOKEN={fill in team token}
$ export DROPBOX_TOKEN={fill in access token}
$ tox -e test_integration

Note: If you do not have all of these tokens available, we run integration tests as a part of pull request validation and you are able to rely on those if you are unable to obtain yourself.

We do recommend developing in a virtual environment in order to ensure you have a clean testing environment.

If you want to build the documentation locally, you can run this:

$ tox -e docs

The documentation will be built into build/html.