Skip to content

Commit a2e26ec

Browse files
docs: add maintainer workflow (#123)
Co-authored-by: Mriyam Tamuli <[email protected]>
1 parent cb16287 commit a2e26ec

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

docs/maintainer-workflow.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Maintainer guide
2+
3+
Welcome to the maintainer guide for our project!
4+
As a project maintainer, you play a crucial role in ensuring the success and health of the project.
5+
Below are key responsibilities and guidelines to help you manage the project effectively.
6+
7+
## Key responsibilities
8+
9+
### Manage Issues
10+
1. Issue Triage
11+
- Establish a regular schedule for reviewing and triaging open issues.
12+
- Close irrelevant issues, and categorize and prioritize others using milestones.
13+
14+
1. Acknowledging an Issue
15+
- Review new issues promptly to address major blockers.
16+
- Leave a comment on the issue to show appreciation for the creator's time and efforts.
17+
- Request additional details if the issue description is unclear.
18+
19+
1. Labelling Issues
20+
- Add appropriate labels to convey the status of each issue.
21+
- Stalebot ignores issues labeled `awaiting-inputs`, `work-in-progress`, and `help-wanted`. See [automation docs](docs/automation.md)
22+
- Guidelines for specific labels:
23+
- `help-wanted`: Use for issues that we want to work on but haven't been picked up.
24+
- `work-in-progress`: Indicate ongoing work without a corresponding pull request.
25+
- `wontfix`/`invalid`: Always add with a clear explanation.
26+
27+
1. Assigning an Issue
28+
- Assign issues to contributors who show interest or agree to work on them.
29+
- If someone has started working on an issue, assign it to them for visibility.
30+
31+
### Manage Pull Requests (PRs)
32+
1. PR review
33+
- Hold off on reviewing until the contributor indicates readiness, unless explicitly asked otherwise.
34+
- Label PRs with `awaiting-inputs` if help is needed to understand the changes.
35+
- Ensure that new features or changes are properly documented.
36+
- Ensure that adequate tests are added (or already exists), create a separate issue if required.
37+
38+
1. PR approval and merge
39+
- Contributors cannot merge PRs, assist them in the merging process.
40+
- Ensure Continuous Integration (CI) passes before merging, except for non-code/test changes.
41+
- [Approve CI builds for first time contributors](https://docs.github.com/en/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks#approving-workflow-runs-on-a-pull-request-from-a-public-fork).
42+
43+
1. Labeling PRs
44+
- Stalebot ignores PRs labeled `awaiting-inputs`, `work-in-progress`, and `help-wanted`.
45+
- It's a good practice to add appropriate labels on PRs.
46+
47+
### Manage Releases
48+
- Choose the correct tag based on major, minor, or patch fixes using [semver versioning](https://semver.org/).
49+
- Aim to create releases promptly to minimize user wait times.
50+
- If possible, update releases with informative release notes highlighting breaking changes, major features, and bug fixes.
51+
52+
### Arrange and Drive Community Meetings
53+
- Attend community meetings to engage with contributors and users.
54+
- Promptly address action items from meeting notes.
55+
- Foster a welcoming, open-minded, respectful, and friendly environment.
56+
57+
### Ensure Code of Conduct Compliance
58+
- Familiarize yourself with the [CNCF code of conduct](https://www.cncf.io/conduct/).
59+
- Enforce the code of conduct among contributors and maintainers, taking necessary actions when required.
60+
61+
### Keeping the Repository Up to Date
62+
- Periodically review documentation and create issues for any missing pieces.
63+
- Implement automation to reduce inconsistencies and enhance productivity.
64+
65+
## Reading materials
66+
For further insights, refer to these valuable resources:
67+
- [Best practices for maintainers](https://opensource.guide/best-practices)
68+
- [Practical skills for maintainers](https://www.freecodecamp.org/news/practical-skills-for-open-source-maintainers)
69+
- [Becoming an open source maintainer](https://kentcdodds.com/blog/becoming-an-open-source-project-maintainer)
70+
71+
**Thank you for your dedication to maintaining our project!**

0 commit comments

Comments
 (0)