Contributing

Contributions are welcomed for the project.

LLM usage disclosure

If you use a large language model (LLM) to help with a contribution, disclose its usage in your pull request. State which tools you used, which parts of the contribution were generated or assisted by them, and to what extent. This applies to code, tests, and documentation.

You are responsible for understanding, reviewing, and validating everything you submit. Keep contributions focused and easy to review. Large LLM-generated contributions that are difficult to understand or review will be rejected.

Human committers

Only human committers are allowed. Every commit must be made and signed off by a human contributor who takes responsibility for the changes. LLMs, AI agents, and bots must not be listed as commit authors, committers, or signatories.

Contributing code

To contribute, you will need Go installed (see the Go installation guide).

1. Fork the Repository

First, fork the repository on GitHub. Then, clone your fork locally:

git clone https://github.com/<your-username>/incus-apply.git
cd incus-apply

2. Create a New Branch

Create a new branch for your changes:

git checkout -b my-feature-branch

3. Commit Your Changes

Commit your changes with a DCO signoff and the required commit message format. Each commit must include a signoff line:

Signed-off-by: Your Name <your.email@example.com>

You can add this automatically with:

git commit -s -m "component: <message>"
# Example:
git commit -s -m "cli: add my-command to colima start"

4. Push Your Branch

Push your branch to your fork:

git push origin my-feature-branch

5. Open a Pull Request

Open a Pull Request against the main incus-apply repository.

6. DCO Signoff

All commits are required to be signed off using the Developer Certificate of Origin (DCO). This is a simple statement that you, as a contributor, have the right to submit your changes.

7. Reviewing and Merging

All PRs are subject to review.

Kindly ensure that your PR passes all CI checks. You are also obliged to respond to review comments and update your PR as needed.

Contributing documentation

The documentation site uses Sphinx, MyST, and the Furo theme, aligned with other Incus-related projects.

Build the docs locally:

make doc

Serve the built docs locally:

make doc-serve

Then open http://localhost:8001/.

Validate your changes

  • Run make doc before submitting changes to verify Sphinx rendering.