Contributing

Contributions to the host application, tooling, guest kernel and documentation are welcome. The product’s CONTRIBUTING.md is the full guide; this page is the short version.

Report a bug

Use the bug report form on GitHub Issues. Include:

• the app version (antinomie --version, or Help → About Antinomie);
• the base name and its guest revision;
• your host distribution, and whether the VM uses KVM or TCG;
• the steps to reproduce;
• the output of antinomie --check-dependencies.

Never attach malware or secrets

Never attach live malware, real credentials or private recordings to a public issue. Describe a sample by its SHA-256, or share a harmless program that reproduces the problem. Recordings, PCAPs and disk images can hold secrets; see Recordings contain secrets.

Report a security problem

Report vulnerabilities privately, never in a public issue: open the repository’s Security tab and choose Report a vulnerability. See Security model for what to include and what to expect.

A sample detecting that it runs in Antinomie is not a vulnerability: new detection methods are welcome as ordinary issues.

Pull requests

• Target the current release-X.Y.Z branch for new work; main carries the latest published release. 0.8.0 work goes to release-0.8.0.
• One topic per pull request, with tests for changed behaviour and the documentation updated in the same change.
• Run the checks CI runs and describe them and their results; never report an unrun check as passing. See Building from source.
• Commit messages say what changed and why.
• Licence. You must own, or have permission to license, what you contribute. New original host and tooling code is GPL-3.0-only; shared kernel headers stay MIT, and kernel-derived files keep their own terms. See Licensing.

Guest and transport changes need a VM to test, and kernel patches follow the kernel packaging workflow in CONTRIBUTING.md.

Versions and guest revisions

Antinomie uses semantic versioning: a bug fix is a patch version, anything a user can see or use is a minor version. The guest kernel has its own contract revision, which changes only when guest-visible kernel behaviour changes, and only with a minor or major release, so a patch release never makes existing bases outdated. See Compatibility.

A release is a tag vX.Y.Z. Its release workflow checks, builds and attests the archive, and publishes it with its SHA256SUMS.

Improve these pages

This documentation website lives in its own repository, antinomie-web, under the MIT licence. The product’s README, user guide and security model are in the product repository.

Building from sourceBuild the host app, run the checks and find the guest kernel workflow.