Skip to content
This repository was archived by the owner on Jul 8, 2023. It is now read-only.

Latest commit

 

History

History
19 lines (16 loc) · 829 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (16 loc) · 829 Bytes

Contributing

As a guideline, please follow this process when contributing:

  1. Fork the repository.
  2. Create a branch from master (git checkout -b branch-name master).
  3. Make the relevant code changes.
  4. If your change will require documentation updates, include them in the same pull request.
  5. Use the various quality checks provided:
    • Run the tests with make test.
    • Generate a coverage report with make coverage, then open coverage/lcov-report/index.html.
    • Check for code style issues with make lint.
  6. Squash commits if necessary (git rebase -i master).
  7. Submit a pull request to the master branch.