Skip to content

Latest commit

 

History

History
20 lines (17 loc) · 763 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (17 loc) · 763 Bytes

Setup for Development

Follow the setup instructions in the README to set up for local development.

Submitting Changes

  1. Fork the repository.
  2. Set up the app per the instructions above and ensure mix test runs cleanly.
  3. Create a topic branch.
  4. Add specs for your unimplemented feature or bug fix.
  5. Run mix test. If your specs pass, return to step 4.
  6. Implement your feature or bug fix.
  7. Re-run mix test --cover. If your specs fail, return to step 6.
  8. Open cover/modules.html. If your changes are not completely covered by the test suite, return to Step 4.
  9. Thoroughly document and comment your code.
  10. Run mix doc and make sure your changes are documented.
  11. Add, commit, and push your changes.
  12. Submit a pull request.