Conventions

This part of the documentation defines a set of common rules and guidelines for developers to follow when working on the CTA project.

This document is a living standard. Proposals for additions or modifications should be raised and agreed upon by the development team. The intent is to continuously refine conventions as the project evolves to promote consistency and best practices. It should be noted that various parts of the existing codebase may not yet conform to these conventions; we are working to bring all code in line over time.

Definitions

The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in the specification are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.