Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 2.66 KB
Raw

Contributing to the Dropbox API V2 Explorer

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:

$ npm install
$ git submodule init
$ git submodule update --remote --recursive
$ cd codegen/stone
$ python setup.py install
$ cd ..
$ sh ./run_codegen.sh

Testing the Code

Tests live under the test/ folder and are then broken down into the type of test it is. To run both the unit tests and the typescript tests, you can use:

$ npm test

To test the build of the webpage, you can use:

$ npm run build

This builds the site once and places the output into the build/ directory.

Running the Explorer Locally

You can run the explorer locally and see changes reflected live as you develop by starting up Gulp:

$ npm run watch