Contributing

Developer Certificate of Origin

Every commit must be signed off with the Signed-off-by: REAL NAME <email@example.com> line.

Use the git commit -s command to add the Signed-off-by line.

See also https://github.com/cncf/foundation/blob/main/dco-guidelines.md.

Licensing

Lima is licensed under the terms of Apache License, Version 2.0.

See also https://github.com/cncf/foundation/blob/main/allowed-third-party-license-policy.md for third-party dependencies.

Sending pull requests

Pull requests can be submitted to https://github.com/lima-vm/lima/pulls.

It is highly suggested to add tests for every non-trivial pull requests. A test can be implemented as a unit test rather than an integration test when it is possible, to avoid slowing the integration test CI.

Merging pull requests

Committers can merge pull requests. Reviewers can approve, but cannot merge, pull requests.

A Committer shouldn’t merge their own pull requests without approval by at least one other Maintainer (Committer or Reviewer).

This rule does not apply to trivial pull requests such as fixing typos, CI failures, and updating image references in templates (e.g., https://github.com/lima-vm/lima/pull/2318).

Last modified June 3, 2024: website: add guide for testing (69c137a)