Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 2.06 KB

maintenance.md

File metadata and controls

44 lines (28 loc) · 2.06 KB

Repository Maintenance

Notes for iguana maintainers

Iguana version

The iguana version is dynamically determined from the most recent git tag in the commit graph:

This will only work if the source tree includes .git/, with tags and history including the most recent tag. If the source code was obtained from a release tarball from GitHub, the .git/ directory will be absent and version detection will fail.

Because of the fragility of version detection, we try to keep at least the major version correct in the fallback version number of the version detection implementation.

Python Binding Dependencies

Keep the Python binding dependency versions reasonably up to date in the corresponding requirements.txt file:

C++ Standard

We currently support up to the C++ standard defined in meson.build; if you change this, you will also need to update:

Code Ownership

We maintain a CODEOWNERS file to track who wrote and maintains each file. If you make significant contributions to any part of the code, please update CODEOWNERS. Pull requests that edit a file that you maintain will automatically request for your review, when marked as ready.

Auto-Formatting

We provide a .clang-format file for auto-formatting C++ code. If your system has clang-format, then meson will create a ninja build target called clang-format, which you may run as

ninja -C <builddir> clang-format

We also use meson.format to format the meson build files.

For semi-automation, the script .github/auto-format.sh will create a new git branch, and then run the auto-formatters; run git diff to see the proposed changes.