Skip to content

Latest commit

 

History

History
55 lines (45 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

55 lines (45 loc) · 2.14 KB
Raw

Contributing

  1. Fork and clone the repo.
  2. Sign up here: https://sandbox.dnsimple.com/
  3. In your sandbox account, navigate to the settings page and add billing info. Under the credit card, add 1 as the number. You can read more here: https://developer.dnsimple.com/sandbox/#testing-subscriptions
  4. Optionally set up your repo to build on Travis CI and to generate coverage reports on CodeCov. Remember to disable concurrent builds on Travis. This prevents inconsistent state on the sandbox account and the tests failing as a result. To do this click on Settings and turn on the option that says Limit concurrent jobs and set the value to 1.
  5. Setup the dev environment:
  6. Set the environment variables in your .bashrc or .bash_profile equivalent:
    • DNSIMPLE_ACCOUNT_ID
    • DNSIMPLE_V2_ACCESS_TOKEN Note: If you set up your repo to build on Travis, please ensure you add these keys on Travis as well.
  7. Create a virtualenv: virtualenv venv -p python3.5
  8. Activate the venv: source venv/bin/activate
  9. Install the dependencies: pip install -r requirements.txt
  10. Run the tests: coverage run -m unittest
  11. Add/remove some code. Send a PR!

Notes

The codebase builds for python 2.7, 3.3, 3.4, 3.5 and 3.6 along with pypy and pypy3. For development you could start on python 3.5. While we do want to be able to support all of the versions above, we must be able to support at least python2.7 and python3.5. You can develop under python3.5 and test your builds for other versions in Travis-CI. There are other workflows for developing for multiple versions locally, but I have not explored them. Please feel free to send a patch updating this section if you think there's a better approach.

Useful links:

Ideas

  • Not all the APIs are covered. Pick one, add one?
  • Check the issue list.
  • Add/improve docs.
  • Anything else is also appreciated.