General Rules

Commit style#

Apollo uses the Conventional Commits format, as seen in the following:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

In particular, we primarily use the following types:

feat: adding a new major feature to Apollo
fix: fixing an issue in Apollo or the repository (e.g., ci workflows, mkosi configuration)
chore: component updates, refactors or other changes that can’t otherwise be classed as a feat or fix
docs: adding documentation to the repositories, including .md files in the repo.

When choosing the scope to use, it’s ultimately your discretion. As a general rule, profile-specific changes should use the profile name, ci/workflow changes should use ci and changes to the base config should use the most appropriate file name (e.g. extra). If appropriate, scope may be omitted entirely.

Use of Generative AI#

This project does not accept contributions that make use of Generative AI technology. This is due to concerns around copyright and contribution quality, as well as real-world externalities caused by use of the technology. This includes, but is not limited to code, art, issues, text. Additionally, machine-learning based translations may only be used in issue trackers or community spaces.

Code of Conduct#

Please make sure that your contribution, including communication around it, follows the Apollo Code of Conduct. This is currently the Contributor Covenant 3.0.