How to contribute

We believe that everyone has something valuable to contribute, whether you’re a coder, a writer, or a tester. Here’s how and why you can get involved:

• Why join us? Work with like-minded people, develop your skills, connect with diverse professionals, and make a difference.

• What do you get? Personal growth, recognition for your contributions, early access to new features, and the joy of seeing your work appreciated.

• Start early, start easy: Dive into code contributions, improve documentation, or be among the first testers. Your presence matters, regardless of experience or the size of your contribution.

The guidelines below will help keep your contributions effective and meaningful.

Code of conduct

When contributing, you must abide by the Ubuntu Code of Conduct .

Licence and copyright

By default, all contributions to ACME are made under the AGPLv3 licence. See the licence in the ACME GitHub repository for details.

All contributors must sign the Canonical contributor licence agreement , which grants Canonical permission to use the contributions. The author of a change remains the copyright owner of their code (no copyright assignment occurs).

Releases and versions

ACME uses semantic versioning ; major releases occur once or twice a year.

The release notes can be found TODO: here .

Environment setup

To work on the project, you need the following prerequisites:

• TODO: Prerequisite 1

• TODO: Prerequisite 2

To install and configure these tools:

TODO: prerequisite command 1
TODO: prerequisite command 2

Submissions

If you want to address an issue or a bug in ACME, notify in advance the people involved to avoid confusion; also, reference the issue or bug number when you submit the changes.

• Fork our GitHub repository and add the changes to your fork, properly structuring your commits, providing detailed commit messages, and signing your commits.

• Make sure the updated project builds and runs without warnings or errors; this includes linting, documentation, code, and tests.

• Submit the changes as a pull request (PR) .

Your changes will be reviewed in due time; if approved, they will eventually be merged.

Describing pull requests

To be properly considered, reviewed, and merged, your pull request must provide the following details:

• Title: Summarise the change in a short, descriptive title.

• Description: Explain the problem that your pull request solves. Mention any new features, bug fixes, or refactoring.

• Relevant issues: Reference any related issues, pull requests, and repositories .

• Testing: Explain whether new or updated tests are included.

• Reversibility: If you propose decisions that may be costly to reverse, list the reasons and suggest steps to reverse the changes if necessary.

Commit structure and messages

Use separate commits for each logical change, and for changes to different components. Prefix your commit messages with the names of components they affect, using the code tree structure. For example, start a commit that updates the ACME service with ACME/service:.

Use conventional commits to ensure consistency across the project:

Ensure correct permissions and ownership for the content mounts

* Work around an ACME issue regarding empty dirs: https://github.com/canonical/ACME/issues/12345

* Ensure the source directory is owned by the user running a container.

Links:
- ...
- ...

Such structure makes it easier to review contributions and simplifies porting fixes to other branches.

Signing commits

To improve contribution tracking, we use the developer certificate of origin (DCO 1.1 ) and require a “sign-off” for any changes going into each branch.

The sign-off is a simple line at the end of the commit message certifying that you wrote it or have the right to commit it as an open-source contribution.

To sign off on a commit, use the --signoff option in git commit.

Code

Formatting and linting

ACME relies on these formatting and linting tools:

• TODO: Tool 1

• TODO: Tool 2

To configure and run them:

TODO: lint command 1
TODO: lint command 2

Structure

• Check linked code elements: Ensure coupled code elements, files, and directories are adjacent. For instance, store test data close to the corresponding test code.

• Group variable declaration and initialisation: Declare and initialise variables together to improve code organisation and readability.

• Split large expressions: Break down large expressions into smaller self-explanatory parts. Use multiple variables where appropriate to make the code more understandable and choose names that reflect their purpose.

• Use blank lines for logical separation: Insert a blank line between two logically separate sections of code to improve its structure and readability.

• Avoid nested conditions: Avoid nesting conditions to improve readability and maintainability.

• Remove dead code and redundant comments: Drop unused or obsolete code and comments to promote a cleaner code base and reduce confusion.

• Normalise symmetries: Treat identical operations consistently, using a uniform approach to improve consistency and readability.

Best practices

Tests

All code contributions must include tests.

To run the tests locally before submitting your changes:

TODO: test command 1
TODO: test command 2

Documentation

ACME’s documentation is stored in the DOCDIR directory of the repository. It is based on the Canonical starter pack and hosted on Read the Docs .

For general guidance, refer to the starter pack guide .

For syntax help and guidelines, refer to the Canonical style guides .

In structuring, the documentation employs the Diátaxis approach.

To run the documentation locally before submitting your changes:

make run

Automatic checks

GitHub runs automatic checks on the documentation to verify spelling, validate links, and suggest inclusive language.

You can (and should) run the same checks locally:

make spelling
make linkcheck
make woke