-
Notifications
You must be signed in to change notification settings - Fork 198
Create CONTRIBUTOR_LADDER.md #4120
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Deploy Preview for zarf-docs canceled.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Documenting maintainer requirements for posterity
CONTRIBUTOR_LADDER.md
Outdated
|
||
**Defined by:** Member of the Zarf GitHub ["Maintainer" team](https://github.com/orgs/zarf-dev/teams/maintainers). | ||
|
||
#### Responsibilities |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would be curious about removing the Pre-requisites
section and rather leaning into Responsibilities
as a "Demonstrates meeting the responsibilities of a maintainer"
brainstorming potential requirements:
## Quantitative
1. Contribution History - sustained contribution over time (typically 6-12 months and some number of significant PRs)
2. Issue Triage - Reviewed, Closed or managed responsibly
3. Code Review - healthy balance of submitted reviews to submitted PRs
4. Camp Cleanliness - generally leaves the state cleaner than before
5. Responsiveness - responds to PRs and issues in a timely manner
## Qualitative
1. Technical Judgement - demonstrates a deep understanding of the project
2. Communication - respectful and constructive in reviews and discussions
3. Initiative - takes ownership of the project and actively participates
4. Reliability - consistent and transparent about bandwidth and limitations
5. Decision Making - makes good decisions about the project and its direction
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Qualitative
- Contribution History - sustained contribution over time (typically 6-12 months and some number of significant PRs)
Added to pre-reqs; refined to 12-month time period & 10 PRs.
- Issue Triage - Reviewed, Closed or managed responsibly.
Added to responsibilities: Issue Triage; added quantities; added 10x issues/week
- Code Review - healthy balance of submitted reviews to submitted PRs
Added to responsibilities: Project control quality; added 1:1 ratio
- Camp Cleanliness - generally leaves the state cleaner than before
Added to B. - how to quantify?
- Responsiveness - responds to PRs and issues in a timely manner
Adjusted E. - how to set achievable goals?
Quantitative
- Technical Judgement - demonstrates a deep understanding of the project
Adjusted A.
- Communication - respectful and constructive in reviews and discussions
These are general expectations for all members of the project. Need to state in "Community Members" responsibilities or is it adequately subsumed under OpenSSF expectations?
- Initiative - takes ownership of the project and actively participates
Moved to responsibilities "C"
- Reliability - consistent and transparent about bandwidth and limitations
Moved to responsibilities "D"
- Decision Making - makes good decisions about the project and its direction
adequately covered under "A"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New Draft:
#### Responsibilities
- A. Technical Judgement - Demonstrate a deep understanding of the project and sound technical judgment
- B. [From Brainstorming] Camp Cleanliness - generally leave the state cleaner than before [Added - possible to quantify?]
- C. [From Brainstorming] Initiative - take ownership of the project and actively participate
- C1. Participate in OpenSSF or Zarf-specific community meetings, if possible
- C2. Facilitate Zarf-specific community meetings, if possible
- C3. Mentor contributors and reviewers
- D. [From Brainstorming] Reliable - consistent and transparent about bandwidth and limitations
- E. [From Brainstorming] Responsive - respond to PRs and issues in a timely manner. [Set quantitative goals?]
- F. Quality Control - Maintain project quality control via code reviews
- F1. [From brainstorming] Maintain healthy balance (~1:1) of submitted reviews to submitted PRs to enable project code collaboration
- F2. Approve and merge code contributions as appropriate [Moved from Responsibilities "E"]
- G. [From Brainstorming] Issue Triage - Responsibly review, close, or manage issues in the backlog: minimum 10x issues per week
#### Pre-requisites
- I. [From Brainstorming] Demonstrates the principles and responsibilities required for qualitative Maintainer Responsibilities
- I. [From Brainstorming] Sustained contribution history over 12 month time period and 10+ significant PRs.
- II. Reviewer for at least 1 month
- III. Reviewed at least 10 substantial PRs to the codebase
- IV. Reviewed or got at least 30 PRs merged to the codebase
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The bullet numbering (e.g., "1", "B", "III", "IV") will be removed in final version. Added them in here to facilitate referencing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated the new draft to get rid of qualitative vs quantitative breakouts.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added responses
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few minor nits, but in general this looks great!
CONTRIBUTOR_LADDER.md
Outdated
|
||
#### Responsibilities | ||
|
||
- Keep participating! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Short on to the point 😉
CONTRIBUTOR_LADDER.md
Outdated
|
||
#### Privileges | ||
|
||
- Tests run against their PRs automatically |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we know this is true with gh actions? Also again PR => pull requests
CONTRIBUTOR_LADDER.md
Outdated
|
||
#### Prerequisites | ||
|
||
- Enabled two-factor authentication on their GitHub account |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's make it easy to understand what it means, link to https://help.github.com/articles/about-two-factor-authentication
CONTRIBUTOR_LADDER.md
Outdated
- Have made contributions to the project in the form of: | ||
- Authoring or reviewing PRs on GitHub. At least one PR must be **merged**. | ||
- Filing or commenting on issues on GitHub | ||
- Contributing to a project, or community discussions (e.g. meetings, Slack, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here, maybe adding a "meaningful contribution" or someting along the lines that is both vague but also open ended, in general something that will allow us to filter out any kind of 👍's and similar
Co-authored-by: Maciej Szulik <maciej@defenseunicorns.com> Signed-off-by: nick-adkins <nick@defenseunicorns.com>
Co-authored-by: Maciej Szulik <maciej@defenseunicorns.com> Signed-off-by: nick-adkins <nick@defenseunicorns.com>
Co-authored-by: Maciej Szulik <maciej@defenseunicorns.com> Signed-off-by: nick-adkins <nick@defenseunicorns.com>
Signed-off-by: nick-adkins <nick@defenseunicorns.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great, looking forward to adding this to our project
CONTRIBUTOR_LADDER.md
Outdated
It also defines the process by which users can request to change roles. These roles are progressive, in that responsibilites and pre-requisites apply to subsequent rungs in the ladder. | ||
|
||
- [Roles](#roles) | ||
- [Community Participants](#community-participants) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: updating #heading-links to match headers
CONTRIBUTOR_LADDER.md
Outdated
|
||
- [Roles](#roles) | ||
- [Community Participants](#community-participants) | ||
- [Contributors](#contributors) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: add Community Members header
CONTRIBUTOR_LADDER.md
Outdated
|
||
#### Prerequisites | ||
|
||
Experience as a Community Member for at least 6 months |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: match bullet format of other prereq sections -
Updated based on comments/feedback/suggestions Signed-off-by: nick-adkins <nick@defenseunicorns.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made changes based on feedback/suggestions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Second attempt at adding contributor ladder. Closing previous PR #4006 to maintain clarity.
Related Issue #2250
Description
...
Related Issue
Fixes #
Relates to #
Checklist before merging