Skip to content

Commit 759e55c

Browse files
AkihiroSudaAkihiroSuda
authored
Merge pull request #2353 from AkihiroSuda/dev-docs
website: add community governance, etc.
2 parents d7f9907 + 4a1c053 commit 759e55c

File tree

10 files changed

+190
-23
lines changed

10 files changed

+190
-23
lines changed

‎.github/workflows/release.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ jobs:
8888
The build log is available for 90 days: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
8989
9090
The sha256sum of the SHA256SUMS file itself is \`${shasha}\` .
91+
- - -
92+
Release manager: [ADD YOUR NAME HERE] (@[ADD YOUR GITHUB ID HERE])`
9193
EOF
9294
- name: "Create release"
9395
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')

‎MAINTAINERS.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1 @@
1-
# Lima maintainers
2-
3-
| Name | GitHub ID (not Twitter ID) | GPG fingerprint |
4-
|--------------------|------------------------------------------------|------------------------------------------------------------------------------------------|
5-
| Akihiro Suda | [@AkihiroSuda](https://github.com/AkihiroSuda) | [C020 EA87 6CE4 E06C 7AB9 5AEF 4952 4C6F 9F63 8F1A](https://github.com/AkihiroSuda.gpg) |
6-
| Jan Dubois | [@jandubois](https://github.com/jandubois) | |
7-
| Anders F Björklund | [@afbjorklund](https://github.com/afbjorklund) | |
8-
| Balaji Vijayakumar | [@balajiv113](https://github.com/balajiv113) | |
9-
10-
See https://github.com/lima-vm/.github/blob/main/SECURITY.md for how to report security issues.
1+
Moved to <https://lima-vm.io/docs/community/governance/>.

‎README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ kubectl apply -f ...
5151
See <https://lima-vm.io/docs/> for the further information.
5252

5353
## Community
54-
<!-- TODO: move or copy the most of this section to https://lima-vm.io/community/ -->
5554
### Adopters
5655

5756
Container environments:

‎ROADMAP.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1 @@
1-
# Lima roadmap
2-
3-
Instead of using a static text file, Lima uses the `roadmap` label on GitHub issues to designate features or bug fixes that we plan to implement.
4-
5-
Issues are tagged with the `roadmap` label when at least one maintainer or contributor has declared intent to work on or help with the implementation.
6-
7-
There are no commitments or timelines attached to the label, and the label may be removed again from an abandoned issue at any time.
8-
9-
Non-roadmap issues are kept open (as long as they fit the scope of the project) in case a volunteer one day appears and offers to work on them.
10-
11-
To find the items currently planned for Lima you can filter on [open issues with the `roadmap` label]( https://github.com/lima-vm/lima/issues?q=is%3Aissue+is%3Aopen+label%3Aroadmap).
1+
Moved to <https://lima-vm.io/docs/community/roadmap/>.

‎website/content/en/docs/Community/Contributing/_index.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Contributing
3+
weight: 20
4+
---
5+
6+
## Developer Certificate of Origin
7+
8+
Every commit must be signed off with the `Signed-off-by: REAL NAME <[email protected]>` line.
9+
10+
Use the `git commit -s` command to add the Signed-off-by line.
11+
12+
See also <https://github.com/cncf/foundation/blob/main/dco-guidelines.md>.
13+
14+
## Licensing
15+
16+
Lima is licensed under the terms of [Apache License, Version 2.0](https://github.com/lima-vm/lima/blob/master/LICENSE).
17+
18+
See also <https://github.com/cncf/foundation/blob/main/allowed-third-party-license-policy.md> for third-party dependencies.
19+
20+
## Sending pull requests
21+
22+
Pull requests can be submitted to <https://github.com/lima-vm/lima/pulls>.
23+
24+
## Merging pull requests
25+
26+
[Committers](../governance) can merge pull requests.
27+
[Reviewers](../governance) can approve, but cannot merge, pull requests.
28+
29+
A Committer shouldn't merge their own pull requests without approval by at least one other Maintainer (Committer or Reviewer).
30+
31+
This rule does not apply to trivial pull requests such as fixing typos, CI failures,
32+
and updating image references in templates (e.g., <https://github.com/lima-vm/lima/pull/2318>).

‎website/content/en/docs/Community/Governance/_index.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: Governance
3+
weight: 10
4+
---
5+
6+
<!-- The governance model is similar to https://github.com/containerd/project/blob/main/GOVERNANCE.md but simplified -->
7+
8+
## Code of Conduct
9+
Lima follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
10+
11+
## Maintainership
12+
Lima is governed by Maintainers who are elected from active contributors.
13+
14+
As a [Cloud Native Computing Foundation](https://cncf.io/) project, Lima will keep its [vendor-neutrality](https://contribute.cncf.io/maintainers/community/vendor-neutrality/).
15+
16+
### Roles
17+
Maintainers consist of two roles:
18+
19+
- **Committer** (Full maintainership): Committers have full write accesses to repos under <https://github.com/lima-vm>.
20+
Committers' commits should still be made via GitHub pull requests (except for urgent security fixes), and should not be pushed directly.
21+
Committers are also recognized as Maintainers in <https://github.com/cncf/foundation/blob/main/project-maintainers.csv>.
22+
23+
- **Reviewer** (Limited maintainership): Reviewers may moderate GitHub issues and pull requests (such as adding labels and cleaning up spams),
24+
but they do not have any access to merge pull requests nor push commits.
25+
A Reviewer is considered as a candidate to become a Committer.
26+
Reviewers are not recognized as Maintainers in <https://github.com/cncf/foundation/blob/main/project-maintainers.csv>.
27+
28+
See also the [Contributing](../contributing) page.
29+
30+
### Current maintainers
31+
32+
| Name | Role | GitHub ID (not X ID) | GPG fingerprint |
33+
|--------------------|-----------|------------------------------------------------|------------------------------------------------------------------------------------------|
34+
| Akihiro Suda | Committer | [@AkihiroSuda](https://github.com/AkihiroSuda) | [C020 EA87 6CE4 E06C 7AB9 5AEF 4952 4C6F 9F63 8F1A](https://github.com/AkihiroSuda.gpg) |
35+
| Jan Dubois | Committer | [@jandubois](https://github.com/jandubois) | [DBF6 DA01 BD81 2D63 3B77 300F A2CA E583 3B6A D416](https://github.com/jandubois.gpg) |
36+
| Anders F Björklund | Committer | [@afbjorklund](https://github.com/afbjorklund) | [5981 D2E8 4E4B 9197 95B3 2174 DC05 CAD2 E73B 0C92](https://github.com/afbjorklund.gpg) |
37+
| Balaji Vijayakumar | Committer | [@balajiv113](https://github.com/balajiv113) | [80E1 01FE 5C89 FCF6 6171 72C8 377C 6A63 934B 8E6E](https://github.com/balajiv113.gpg) |
38+
39+
<!-- TODO: invite non-committer reviewers -->
40+
41+
### Addition and promotion of Maintainers
42+
An active contributor to the project can be invited as a Reviewer,
43+
and can be eventually promoted to a Committer after 2 months at least.
44+
45+
A contributor who have made significant contributions in quality and in quantity
46+
can be also directly invited as a Committer.
47+
48+
A proposal to add or promote a Maintainer must be approved by 2/3 of the Committers who vote within 7 days.
49+
Voting needs 2 approvals at least. The proposer can vote too.
50+
51+
A proposal should happen as a GitHub pull request to the Maintainer list above.
52+
It is highly suggested to reach out to the Committers before submitting a pull request to check the will of the Committers.
53+
54+
### Removal and demotion of Maintainers
55+
A Maintainer who do not show significant activities for 6 months, or, who have been violating the Code of Conduct,
56+
may be demoted or removed from the project.
57+
58+
A proposal to demote or remove a Maintainer must be approved by 2/3 of the Committers (excluding the person in question) who vote within 14 days.
59+
Voting needs 2 approvals at least. The proposer can vote too.
60+
61+
A proposal may happen as a GitHub pull request, or, as a private discussion in the case of removal of a harmful Maintainer.
62+
It is highly suggested to reach out to the Committers before submitting a pull request to check the will of the Committers.
63+
64+
### Other decisions
65+
Any decision that is not documented here can be made by the Committers.
66+
When a dispute happens across the Committers, it will be resolved through a majority vote within the Committers.
67+
A tie should be considered as a failed vote.
68+
69+
## Release process
70+
71+
Eligibility to be a release manager:
72+
- MUST be an active Committer
73+
- MUST have the GPG fingerprint listed in the maintainer list above
74+
- MUST upload the GPG public key to `https://github.com/USERNAME.gpg`
75+
- MUST protect the GPG key with a passphrase or a hardware token.
76+
77+
Release steps:
78+
- Open an issue to propose making a new release. e.g., <https://github.com/lima-vm/lima/issues/2296>.
79+
The proposal should be public, with an exception for vulnerability fixes.
80+
If this is the first time for you to take a role of release management,
81+
you SHOULD make a beta (or alpha, RC) release as an exercise before releasing GA.
82+
- Make sure that all the merged PRs are associated with the correct [Milestone](https://github.com/lima-vm/lima/milestones).
83+
- Run `git tag --sign vX.Y.Z-beta.W` .
84+
- Run `git push UPSTREAM vX.Y.Z-beta.W` .
85+
- Wait for the `Release` action on GitHub Actions to complete. A draft release will appear in https://github.com/lima-vm/lima/releases .
86+
- Download `SHA256SUMS` from the draft release, and confirm that it corresponds to the hashes printed in the build logs on the `Release` action.
87+
- Sign `SHA256SUMS` with `gpg --detach-sign -a SHA256SUMS` to produce `SHA256SUMS.asc`, and upload it to the draft release.
88+
- Add release notes in the draft release, to explain the changes and show appreciation to the contributors.
89+
Make sure to fulfill the `Release manager: [ADD YOUR NAME HERE] (@[ADD YOUR GITHUB ID HERE])` line with your name.
90+
e.g., `Release manager: Akihiro Suda (@AkihiroSuda)` .
91+
- Click the `Set as a pre-release` checkbox if this release is a beta (or alpha, RC).
92+
- Click the `Publish release` button.
93+
- Close the [Milestone](https://github.com/lima-vm/lima/milestones).

‎website/content/en/docs/Community/Roadmap/_index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Roadmap
3+
weight: 50
4+
---
5+
6+
Instead of using a static text file, Lima uses the `roadmap` label on GitHub issues to designate features or bug fixes that we plan to implement.
7+
8+
Issues are tagged with the `roadmap` label when at least one maintainer or contributor has declared intent to work on or help with the implementation.
9+
10+
There are no commitments or timelines attached to the label, and the label may be removed again from an abandoned issue at any time.
11+
12+
Non-roadmap issues are kept open (as long as they fit the scope of the project) in case a volunteer one day appears and offers to work on them.
13+
14+
To find the items currently planned for Lima you can filter on [open issues with the `roadmap` label]( https://github.com/lima-vm/lima/issues?q=is%3Aissue+is%3Aopen+label%3Aroadmap).

‎website/content/en/docs/Community/Subprojects/_index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Subprojects
3+
weight: 90
4+
---
5+
6+
Some portions of Lima are useful for other projects too and split out to separate repos:
7+
8+
- <https://github.com/lima-vm/socket_vmnet>: vmnet.framework support for unmodified rootless QEMU
9+
- <https://github.com/lima-vm/go-qcow2reader>: qcow2 reader for Go
10+
- <https://github.com/lima-vm/sshocker>: ssh + reverse sshfs + port forwarder, in Docker-like CLI (predecessor of Lima)
11+
- <https://github.com/lima-vm/alpine-lima>: Create an alpine based image for lima
12+
13+
See also <https://github.com/lima-vm> for other subprojects.
14+
15+
The maintainership of the subprojects corresponds to the [maintainership](../governance) of Lima itself.

‎website/content/en/docs/Community/_index.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Community
3+
weight: 400
4+
---
5+
6+
The GitHub repo of Lima can be found at <https://github.com/lima-vm/lima>.
7+
8+
## Communication channels
9+
10+
- [GitHub Discussions](https://github.com/lima-vm/lima/discussions)
11+
12+
- `#lima` channel in the CNCF Slack
13+
- New account: <https://slack.cncf.io/>
14+
- Login: <https://cloud-native.slack.com/>
15+
16+
- Zoom meetings are currently not regularly held due to timezone diversity,
17+
but feel free to reach out to us if you want to host meetings
18+
19+
- See <https://github.com/lima-vm/.github/blob/main/SECURITY.md> for how to report security issues.
20+
21+
## Projects using Lima
22+
23+
### Container environments
24+
- [Rancher Desktop](https://rancherdesktop.io/): Kubernetes and container management to the desktop
25+
- [Colima](https://github.com/abiosoft/colima): Docker (and Kubernetes) on macOS with minimal setup
26+
- [Finch](https://github.com/runfinch/finch): Finch is a command line client for local container development
27+
- [Podman Desktop](https://podman-desktop.io/): Podman Desktop GUI has a plug-in for Lima virtual machines
28+
29+
### GUI
30+
- [Lima xbar plugin](https://github.com/unixorn/lima-xbar-plugin): [xbar](https://xbarapp.com/) plugin to start/stop VMs from the menu bar and see their running status.
31+
- [lima-gui](https://github.com/afbjorklund/lima-gui): Qt GUI for Lima

‎website/layouts/partials/community_links.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ <h2>{{ T "community_develop" }}</h2>
1616
{{ end }}
1717
<p>
1818
{{ T "community_how_to" . }}
19-
<a href="https://github.com/lima-vm/lima#developer-guide">{{ T "community_guideline" }}</a>.
19+
<a href="/docs/community">{{ T "community_guideline" }}</a>.
2020
</p>
2121
</div>
2222
</section>

0 commit comments

Comments
 (0)