Skip to content

Commit 6ed6256

Browse files
authored
docs: update community roles and responsibilities (#104)
Signed-off-by: Gaius <gaius.qi@gmail.com>
1 parent eaf4b41 commit 6ed6256

File tree

6 files changed

+57
-76
lines changed

6 files changed

+57
-76
lines changed

COMMUNITY_LADDER.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,12 @@ As the project grows, these roles and responsibilities might change. The final s
9191
A **Contributor** is anyone who adds value to the project. This can be through code, but it doesn't have to be! This role is often where new or occasional contributors start.
9292

9393
- **Responsibilities**:
94+
9495
- Follow the project's [Code of Conduct](CODE_OF_CONDUCT.md).
9596
- Stick to the [Contribution Guide](CONTRIBUTING.md).
9697

9798
- **Qualifications**:
99+
98100
- Open to anyone who wants to be part of the community.
99101
- Contributions can include things like:
100102
- Joining in on community discussions.
@@ -116,10 +118,12 @@ This is the first step to becoming a Member.
116118
A **Member** is a consistent contributor who is actively involved in the project. They have more permissions in our repositories and are trusted to act in the community's best interest.
117119

118120
- **Responsibilities**:
121+
119122
- Make regular contributions to the project.
120123
- Finish any tasks or initiatives you volunteer for.
121124

122125
- **Qualifications**:
126+
123127
- A history of successful contributions, including at least one of these:
124128
- Submitting or reviewing PRs.
125129
- Fixing issues or bugs.
@@ -141,13 +145,15 @@ The current Member list is maintained in the [MEMBERS.md](roles/Members.md) file
141145
An **Approver** is a Member who takes ownership of a specific part of the project (like code, docs, or tests). They play a key role in keeping our quality high by reviewing and approving changes in their area.
142146

143147
- **Responsibilities**:
148+
144149
- Handle all the responsibilities of a Member.
145150
- Regularly review PRs in your area of expertise.
146151
- Make sure changes meet our coding standards, don't introduce bugs, and are good for the project.
147152
- Help other contributors become Approvers.
148153
- Help triage issues.
149154

150155
- **Qualifications**:
156+
151157
- You must already be a Member.
152158
- Proven track record of high-quality reviews and contributions.
153159
- Deep understanding of your specific area.
@@ -165,6 +171,7 @@ The current Approver list is maintained in the [Approvers.md](roles/Approvers.md
165171
A **Maintainer** is a highly trusted member of the project with the authority to merge code, vote on project matters, and help guide the project's direction. This role is for those who have shown a deep commitment to our community.
166172

167173
- **Responsibilities**:
174+
168175
- Fulfill all the responsibilities of an Approver.
169176
- Merge PRs to the main branch.
170177
- Maintain the codebase's overall quality, stability, and performance.
@@ -176,6 +183,7 @@ A **Maintainer** is a highly trusted member of the project with the authority to
176183
- Approve promotions to various roles within the project.
177184

178185
- **Qualifications**:
186+
179187
- The specifics are detailed in our project's [governance document](./GOVERNANCE.md) under the commit access criteria.
180188
- A history of long-term, high-quality contributions and leadership.
181189
- In-depth understanding of the project’s architecture and design.

CONTRIBUTING.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -70,51 +70,51 @@ To submit a PR, you'll need a GitHub account. Once you have one, follow these st
7070

7171
1. **FORK** Dragonfly to your own repository.
7272

73-
To do this, just click the "Fork" button in the top-right corner of the [dragonflyoss/dragonfly](https://github.com/dragonflyoss/dragonfly) main page. This will create a copy of the repository under your own account at `https://github.com/<your-username>/dragonfly`.
73+
To do this, just click the "Fork" button in the top-right corner of the [dragonflyoss/dragonfly](https://github.com/dragonflyoss/dragonfly) main page. This will create a copy of the repository under your own account at `https://github.com/<your-username>/dragonfly`.
7474

7575
2. **CLONE** your forked repository to your local machine.
7676

77-
Use `git clone --recurse-submodules https://github.com/<your-username>/dragonfly.git` to clone the repository locally. Now you can create new branches and make your changes.
77+
Use `git clone --recurse-submodules https://github.com/<your-username>/dragonfly.git` to clone the repository locally. Now you can create new branches and make your changes.
7878

7979
3. **Set the remote upstream** to `https://github.com/dragonflyoss/dragonfly.git`.
8080

81-
Run these two commands:
81+
Run these two commands:
8282

83-
```bash
84-
git remote add upstream https://github.com/dragonflyoss/dragonfly.git
85-
git remote set-url --push upstream no-pushing
86-
```
83+
```bash
84+
git remote add upstream https://github.com/dragonflyoss/dragonfly.git
85+
git remote set-url --push upstream no-pushing
86+
```
8787

88-
With this remote setup, your git remote configuration should look like this:
88+
With this remote setup, your git remote configuration should look like this:
8989

90-
```bash
91-
$ git remote -v
92-
origin https://github.com/<your-username>/dragonfly.git (fetch)
93-
origin https://github.com/<your-username>/dragonfly.git (push)
94-
upstream https://github.com/dragonflyoss/dragonfly.git (fetch)
95-
upstream no-pushing (push)
96-
```
90+
```bash
91+
$ git remote -v
92+
origin https://github.com/<your-username>/dragonfly.git (fetch)
93+
origin https://github.com/<your-username>/dragonfly.git (push)
94+
upstream https://github.com/dragonflyoss/dragonfly.git (fetch)
95+
upstream no-pushing (push)
96+
```
9797

98-
This setup makes it easy to keep your local branches in sync with the main project.
98+
This setup makes it easy to keep your local branches in sync with the main project.
9999

100100
4. **Create a branch** to add a new feature or fix an issue.
101101

102-
First, update your local working directory:
102+
First, update your local working directory:
103103

104-
```bash
105-
cd dragonfly
106-
git fetch upstream
107-
git checkout main
108-
git rebase upstream/main
109-
```
104+
```bash
105+
cd dragonfly
106+
git fetch upstream
107+
git checkout main
108+
git rebase upstream/main
109+
```
110110

111-
Then, create a new branch for your work:
111+
Then, create a new branch for your work:
112112

113-
```bash
114-
git checkout -b <new-branch>
115-
```
113+
```bash
114+
git checkout -b <new-branch>
115+
```
116116

117-
Now you can make your changes on the `new-branch`, then build and test your code.
117+
Now you can make your changes on the `new-branch`, then build and test your code.
118118

119119
### Branching Strategy
120120

GOVERNANCE.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,3 @@ Any major changes to this governance document will be discussed among the Mainta
4040
## Security Reporting
4141

4242
Security is a top priority for us. If you find a security vulnerability, please check our [Dragonfly Security Reporting guide](SECURITY.md) for instructions on how to report it responsibly.
43-
44-
## Contact
45-
46-
Join the conversation and become a part of our community!
47-
48-
- **Slack**: Chat with us on the [#dragonfly](https://cloud-native.slack.com/messages/dragonfly/) channel in the [CNCF Slack](https://slack.cncf.io/).
49-
- **GitHub Discussions**: Have questions or ideas? Join the [Dragonfly Discussion Forum](https://github.com/dragonflyoss/dragonfly/discussions).
50-
- **Developer Group**: <dragonfly-developers@googlegroups.com>
51-
- **Maintainer Group**: <dragonfly-maintainers@googlegroups.com>
52-
- **Twitter**: Follow us at [@dragonfly_oss](https://twitter.com/dragonfly_oss).
53-
- **DingTalk**: [22880028764](https://qr.dingtalk.com/action/joingroup?code=v1,k1,pkV9IbsSyDusFQdByPSK3HfCG61ZCLeb8b/lpQ3uUqI=&_dt_no_comment=1&origin=11)
54-
55-
This document provides a clear framework for the healthy growth of the Dragonfly project. As our community and project evolve, we may update it from time to time.

releases/2.3.0/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Dragonfly v2.3.0 is released!
1+
# Dragonfly v2.3.0 is released
22

3-
Dragonfly v2.3.0 is released! 🎉🎉🎉 Thanks the [contributors](https://github.com/dragonflyoss/dragonfly/graphs/contributors) who made this release happend and welcome you to visit [d7y.io](https://d7y.io) website.
3+
Dragonfly v2.3.0 is released!🎉🎉🎉 Thanks the [contributors](https://github.com/dragonflyoss/dragonfly/graphs/contributors) who made this release happend and welcome you to visit [d7y.io](https://d7y.io) website.
44

55
![dragonfly](images/dragonfly-linear.png)
66

@@ -20,7 +20,7 @@ $ dfcache import /tmp/file.txt
2020
```
2121

2222
```shell
23-
$ dfcache export 2229733261 -O /tmp/file.txt
23+
dfcache export 2229733261 -O /tmp/file.txt
2424
```
2525

2626
![p2](images/p2.webp)
@@ -141,6 +141,7 @@ For detailed information on the specific security issues addressed and the corre
141141
## Nydus
142142

143143
### New features and enhancements
144+
144145
- nydusify copy: support chunked upload and retry mechanisms to handle large image blobs.
145146
- nydusify check: refactor to support OCI v1 and nydus format images as both source and target.
146147
- nydusd: support chunk-level CRC data validation for image data consistency.

roles/Members.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ This document lists all current members of the Dragonfly community, along with t
66

77
<!-- markdownlint-disable -->
88

9-
| GitHub ID | Name | Email | Company or Organization |
10-
| :-------: | :---: | :---: | :---------------------: |
9+
| GitHub ID | Name | Email | Company or Organization |
10+
| :-----------------------------------: | :-----------: | :------------------: | :------------------------------------------: |
1111
| [Zephyr](https://github.com/Zephyrcf) | Changfu Zhang | zinsist777@gmail.com | University of Science and Technology Beijing |
1212

1313
<!-- markdownlint-restore -->
@@ -18,7 +18,7 @@ Below is the list of emeritus (retired) members. Thank them for their contributi
1818

1919
<!-- markdownlint-disable -->
2020

21-
| GitHub ID | Name | Email | Company or Organization |
22-
| :-------: | :---: | :---: | :---------------------: |
21+
| GitHub ID | Name | Email | Company or Organization |
22+
| :-------: | :--: | :---: | :---------------------: |
2323

2424
<!-- markdownlint-restore -->

roles/README.md

Lines changed: 13 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,29 @@
1-
# Dragonfly Community Roles
1+
# Community Roles
22

33
This directory contains information about the various roles and membership levels within the Dragonfly community. Our community follows a structured approach to governance and participation, with different levels of responsibility and access.
44

5-
## Role Definitions
5+
## Members
66

7-
The Dragonfly community has several membership levels, each with specific responsibilities and privileges:
7+
You can find the list of all members in the [Members.md](Members.md).
88

9-
### [Members](Members.md)
9+
## Approvers
1010

11-
Community members who have made sustained contributions to the project and are committed to its continued development.
11+
You can find the list of all approvers in the [Approvers.md](Approvers.md).
1212

13-
### [Approvers](Approvers.md)
13+
## Maintainers
1414

15-
Contributors who have the ability to approve pull requests and are responsible for maintaining code quality in specific areas.
15+
You can find the list of all maintainers in the [Maintainers.md](Maintainers.md).
1616

17-
### [Maintainers](Maintainers.md)
17+
## Security Team
1818

19-
Senior contributors who have overall responsibility for the project direction, architecture decisions, and community governance.
20-
21-
### [Security Team](Security-Team.md)
22-
23-
Dedicated team members responsible for handling security issues, vulnerability reports, and security-related communications.
19+
You can find the list of all security team members in the [Security-Team.md](Security-Team.md).
2420

2521
## Subprojects
2622

27-
The Dragonfly community has several subprojects, each with its own maintainers and contributors. [According the governance model](../GOVERNANCE.md#scope), subprojects adhere to the same governance principles as the main project but may simplify some governance processes and roles due to their smaller scale.
28-
29-
### Maintainers
30-
31-
- [nydus](https://github.com/dragonflyoss/nydus) maintainers are located in the [nydus repository](https://github.com/dragonflyoss/nydus/blob/master/MAINTAINERS.md).
32-
33-
## Getting Involved
34-
35-
If you're interested in contributing to Dragonfly and potentially taking on a community role, please:
23+
The community has several subprojects, each with its own maintainers and contributors. [According the governance model](../GOVERNANCE.md#scope), subprojects adhere to the same governance principles as the main project but may simplify some governance processes and roles due to their smaller scale.
3624

37-
1. Start by reading our [Community Membership](../COMMUNITY_MEMBERSHIP.md) guidelines
38-
2. Review the [Community Ladder](../COMMUNITY_LADDER.md) to understand progression paths
39-
3. Check out our [Contributing Guidelines](../CONTRIBUTING.md)
40-
4. Join our community discussions and start contributing!
25+
### Nydus
4126

42-
## Governance
27+
#### Maintainers {#nydus-maintainers}
4328

44-
For information about how decisions are made in the Dragonfly community, please refer to our [Governance](../GOVERNANCE.md) document.
29+
You can find the list of all maintainers in the [Nydus-Maintainers.md](https://github.com/dragonflyoss/nydus/blob/master/MAINTAINERS.md).

0 commit comments

Comments
 (0)