How to contribute

Git workflow

We work on the master branch but otherwise follow the standard git workflow:

1. Fork, branch, modify.
2. Commit, push.
3. Open pull request.

Worth a read: git basics, git branching, git commit messages, git workflow.

Development guidelines

• Stick to the STL/Boost naming convention, that is, write everything in lower-case with underscores (push_back), except:
  • macros: capital with underscores prefixed with HM3_ (HM3_ASSERT), and
  • concepts: camel case (RandomAccessIterator).
• Document code using /// doxygen-style comments.
• Indent code using make fmt (requires clang-format).
• Unit-Test your code:
  • for examples, see the /test directory,
  • use make cov to check the tests coverage.