Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (24 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 1.27 KB

C++ coding guidelines

Code should pass the pre-commit hook (including formatting by clang-format).

Code should have no build warnings (on supported platform-compiler combinations) and no warnings from clang-tidy.

Suppressing clang-tidy warnings (with NOLINT comments) is allowed if well-considered. The reason for suppression should be left as a comment if not obvious from the context.

For things that are not mechanically detected or corrected, follow the existing convention (for example, names are in snake_case except for template parameters, which are in PascalCase).

All new code should be accompanied with good unit tests. API functions and types should be documented with Doxygen comments (follow existing practice).

Python coding guidelines

Public API symbols should carry NumPy-style docstrings; these are rendered into the Sphinx site under docs/python/. Build the Python docs locally with ninja -C <builddir> docs/python after installing the optional docs dependency group (pip install -e .[docs]) and configuring with -Dpython_docs=enabled.