Thank you for considering Effcee development! Please make sure you review CONTRIBUTING.md
for important preliminary info.
Instructions for first-time building can be found in README.md
. Incremental build after a source change can be done using bazel
or ninja
(or cmake --build
) and ctest
exactly as in the first-time procedure.
We use GitHub issues to track bugs, enhancement requests, and questions. See the project's Issues page.
For all but the most trivial changes, we prefer that you file an issue before submitting a pull request. An issue gives us context for your change: what problem are you solving, and why. It also allows us to provide feedback on your proposed solution before you invest a lot of effort implementing it.
All submissions are subject to review via the GitHub pull review process. Reviews will cover:
To respond to feedback, submit one or more new commits to the pull request branch. The project maintainer will normally clean up the submission by squashing feedback response commits. We maintain a linear commit history, so submission will be rebased onto master before merging.
There is a lot we won't say about testing. However:
For C++, we follow the Google C++ style guide.
Use clang-format
to format the code.
For our Python files, we aim to follow the Google Python style guide.