.. _Chap:Contributing:

Overview
========

This section describes how to build and run the EBGeometry test suite locally,
what the continuous integration (CI) pipeline checks, and the conventions
expected of contributions.  It is split into three pages, one per topic:

* :ref:`Chap:TestingLocally` — building and running the Catch2 unit test suite, CMake presets,
  sanitizers, and a table of what each test binary covers.
* :ref:`Chap:ContinuousIntegration` — what the GitHub Actions CI pipeline checks on every pull
  request, and how to reproduce those checks locally with ``pre-commit``.
* :ref:`Chap:ContributionGuidelines` — code style, static and dynamic assertions, and test
  coverage expected of new code.