Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

27 lines (22 loc) · 1.38 KB

Contributing

Because many of the project's unit tests depend on sensitive API keys, and Travis CI has no easy way to handle this sensitive data from external pull requests, there are some gymnastics required to submit a pull request.

General Workflow

  1. Fork the repo
  2. Cut a namespaced feature branch from master
  • bug/...
  • feat/...
  • test/...
  • doc/...
  • refactor/...
  1. Make commits to your feature branch. Please ensure commit messages are written in present tense.
  2. When you've finished with your fix or feature, rebase upstream changes into your branch. submit a pull request to the develop branch. Include a description of your changes.
  3. Your pull request (PR) will be reviewed by another maintainer. A maintainer will create a new namespaced branch, alter your PR's destination to be that branch, and merge it.
  4. A maintainer will make an essentially identical PR from your new namespaced branch on the main repo to the develop branch. This ensures that Travis will run its tests with the necessary API keys.
  5. Once the pull request has been reviewed, it will be merged by another member of the team.

Questions?

For any additional questions, related to workflow or otherwise, feel free to open an issue to start a conversation.