Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.17 KB

contributing.md

File metadata and controls

30 lines (24 loc) · 1.17 KB
Raw

Contributing

Contributing Code/Features/Bug Fixes

The work on this project roughly follows git flow, but without a bugfix or release branch. In short, work is laid out in an issue, done in a feature branch, tested in the develop branch, and finally added to the main branch.

  1. Make an issue
    • Describe the feature or change
    • Explain the rationale
    • Watch the thread for replies and discussion
  2. Make a branch
    • Do work on this branch
    • Add tests that demonstrate/exercise the expected code use
    • Add tests that illustrate expected/known edge cases
  3. Create pull request (PR) against develop branch
    • Squash commits into single or few related chunks of work.
    • Watch the PR thread for replies and discussion
    • Watch the PR for continuous integration results

Commits

Commit messages:

  • Written in present tense.
  • Answers the question "why?" the code

Formatting and Linting

For c++ code, use clang-lint and clang-format from LLVM. Configuration will be included in project files.

For python code, use flake8.