From 1fec4a6754bbf509ea6e43a7b4125a154b36e6ac Mon Sep 17 00:00:00 2001 From: Mugdha Adhav Date: Mon, 15 Jan 2024 11:27:28 +0530 Subject: [PATCH 1/6] docs: add documentation for maintainers --- docs/maintainer-workflow.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/maintainer-workflow.md diff --git a/docs/maintainer-workflow.md b/docs/maintainer-workflow.md new file mode 100644 index 0000000..06e969c --- /dev/null +++ b/docs/maintainer-workflow.md @@ -0,0 +1,14 @@ +# Maintainer guide + +This page is a checklist for sub-project maintainers to follow before approving patches + +# Some key responsibilities +1. PR reviews and approvals +1. Creating stable releases and providing more information in release notes +1. Trying to keep documentation up to date +1. Appropriately labelling issues, PRs, discussions, etc. + +## Reading materials +- [Best practices for maintainers](https://opensource.guide/best-practices) +- [Practical skills for maintainers](https://www.freecodecamp.org/news/practical-skills-for-open-source-maintainers) +- [Becoming an open source maintainer](https://kentcdodds.com/blog/becoming-an-open-source-project-maintainer) From 39554cbb1a0d017c87e37b78e41d580088895dad Mon Sep 17 00:00:00 2001 From: Mugdha Adhav Date: Sat, 20 Jan 2024 23:38:15 +0530 Subject: [PATCH 2/6] docs [skip ci]: add maintainer workflow --- docs/maintainer-workflow.md | 68 +++++++++++++++++++++++++++++++++---- 1 file changed, 62 insertions(+), 6 deletions(-) diff --git a/docs/maintainer-workflow.md b/docs/maintainer-workflow.md index 06e969c..ac52421 100644 --- a/docs/maintainer-workflow.md +++ b/docs/maintainer-workflow.md @@ -1,14 +1,70 @@ # Maintainer guide -This page is a checklist for sub-project maintainers to follow before approving patches +Welcome to the maintainer guide for our project! +As a project maintainer, you play a crucial role in ensuring the success and health of the project. +Below are key responsibilities and guidelines to help you manage the project effectively. -# Some key responsibilities -1. PR reviews and approvals -1. Creating stable releases and providing more information in release notes -1. Trying to keep documentation up to date -1. Appropriately labelling issues, PRs, discussions, etc. +## Key responsibilities + +### Manage Issues +1. Issue Triage + - Establish a regular schedule for reviewing and triaging open issues. + - Close irrelevant issues, and categorize and prioritize others using milestones. + +1. Acknowledging an Issue + - Review new issues promptly to address major blockers. + - Leave a comment on the issue to show appreciation for the creator's time and efforts. + - Request additional details if the issue description is unclear. + +1. Labelling Issues + - Add appropriate labels to convey the status of each issue. + - Stalebot ignores issues labeled `awaiting-inputs`, `work-in-progress`, and `help-wanted`. + - Guidelines for specific labels: + - [ help-wanted ]: Use for issues that we want to work on but haven't been picked up. + - [ work-in-progress ]: Indicate ongoing work without a corresponding pull request. + - [ wontfix ] [ invalid ]: Always add with a clear explanation. + +1. Assigning an Issue + - Assign issues to contributors who show interest or agree to work on them. + - If someone has started working on an issue, assign it to them for visibility. + +### Manage Pull Requests (PRs) +1. PR review + - Hold off on reviewing until the contributor indicates readiness, unless explicitly asked otherwise. + - Label PRs with `awaiting-inputs` if help is needed to understand the changes. + - Ensure that new features or changes are properly documented. + - Ensure that adequate tests are added (or already exists), create a separate issue if required. + +1. PR approval and merge + - Contributors cannot merge PRs, assist them in the merging process. + - Ensure Continuous Integration (CI) passes before merging, except for non-code/test changes. + +1. Labeling PRs + - Stalebot ignores PRs labeled `awaiting-inputs`, `work-in-progress`, and `help-wanted`. + - It's a good practice to add appropriate labels on PRs. + +### Manage Releases +- Choose the correct tag based on major, minor, or patch fixes using [semver versioning](https://semver.org/). +- Aim to create releases promptly to minimize user wait times. +- If possible, update releases with informative release notes highlighting breaking changes, major features, and bug fixes. + +### Arrange and Drive Community Meetings +- Attend community meetings to engage with contributors and users. +- Promptly address action items from meeting notes. +- Foster a welcoming, open-minded, respectful, and friendly environment. + +### Ensure Code of Conduct Compliance +- Familiarize yourself with the [CNCF code of conduct](https://www.cncf.io/conduct/). +- Enforce the code of conduct among contributors and maintainers, taking necessary actions when required. + +### Keeping the Repository Up to Date +- Periodically review documentation and create issues for any missing pieces. +- Implement automation to reduce inconsistencies and enhance productivity. ## Reading materials +For further insights, refer to these valuable resources: - [Best practices for maintainers](https://opensource.guide/best-practices) - [Practical skills for maintainers](https://www.freecodecamp.org/news/practical-skills-for-open-source-maintainers) - [Becoming an open source maintainer](https://kentcdodds.com/blog/becoming-an-open-source-project-maintainer) + +**Thank you for your dedication to maintaining our project!** From 7c3a3a0253376a769f2e784dcddbfc7e55121784 Mon Sep 17 00:00:00 2001 From: Mugdha Adhav Date: Sun, 21 Jan 2024 00:27:48 +0530 Subject: [PATCH 3/6] Update docs/maintainer-workflow.md Co-authored-by: Mriyam Tamuli --- docs/maintainer-workflow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintainer-workflow.md b/docs/maintainer-workflow.md index ac52421..3e82e9e 100644 --- a/docs/maintainer-workflow.md +++ b/docs/maintainer-workflow.md @@ -18,7 +18,7 @@ Below are key responsibilities and guidelines to help you manage the project eff 1. Labelling Issues - Add appropriate labels to convey the status of each issue. - - Stalebot ignores issues labeled `awaiting-inputs`, `work-in-progress`, and `help-wanted`. + - Stalebot ignores issues labeled `awaiting-inputs`, `work-in-progress`, and `help-wanted`. See [automation docs](docs/automation.md) - Guidelines for specific labels: - [ help-wanted ]: Use for issues that we want to work on but haven't been picked up. - [ work-in-progress ]: Indicate ongoing work without a corresponding pull request. From 80e02acd3943544b4ab60b570c37221be7ff7fd0 Mon Sep 17 00:00:00 2001 From: Mugdha Adhav Date: Sun, 21 Jan 2024 00:27:57 +0530 Subject: [PATCH 4/6] Update docs/maintainer-workflow.md Co-authored-by: Mriyam Tamuli --- docs/maintainer-workflow.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/maintainer-workflow.md b/docs/maintainer-workflow.md index 3e82e9e..1fa094d 100644 --- a/docs/maintainer-workflow.md +++ b/docs/maintainer-workflow.md @@ -20,9 +20,9 @@ Below are key responsibilities and guidelines to help you manage the project eff - Add appropriate labels to convey the status of each issue. - Stalebot ignores issues labeled `awaiting-inputs`, `work-in-progress`, and `help-wanted`. See [automation docs](docs/automation.md) - Guidelines for specific labels: - - [ help-wanted ]: Use for issues that we want to work on but haven't been picked up. - - [ work-in-progress ]: Indicate ongoing work without a corresponding pull request. - - [ wontfix ] [ invalid ]: Always add with a clear explanation. + - `help-wanted`: Use for issues that we want to work on but haven't been picked up. + - `work-in-progress`: Indicate ongoing work without a corresponding pull request. + - `wontfix`/`invalid`: Always add with a clear explanation. 1. Assigning an Issue - Assign issues to contributors who show interest or agree to work on them. From 4ebcff3a03ecc78dbda731ffbe57532fbbb6cb86 Mon Sep 17 00:00:00 2001 From: Mugdha Adhav Date: Sun, 21 Jan 2024 00:39:57 +0530 Subject: [PATCH 5/6] Add instructions for approving CI builds --- docs/maintainer-workflow.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/maintainer-workflow.md b/docs/maintainer-workflow.md index 1fa094d..223df5b 100644 --- a/docs/maintainer-workflow.md +++ b/docs/maintainer-workflow.md @@ -38,6 +38,7 @@ Below are key responsibilities and guidelines to help you manage the project eff 1. PR approval and merge - Contributors cannot merge PRs, assist them in the merging process. - Ensure Continuous Integration (CI) passes before merging, except for non-code/test changes. + - Approve CI builds for first time contributors. 1. Labeling PRs - Stalebot ignores PRs labeled `awaiting-inputs`, `work-in-progress`, and `help-wanted`. From 851c5e9cac04ea847f2de01422a0255f88c6e1bf Mon Sep 17 00:00:00 2001 From: Mugdha Adhav Date: Sun, 21 Jan 2024 00:51:08 +0530 Subject: [PATCH 6/6] Add link [skip ci] --- docs/maintainer-workflow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintainer-workflow.md b/docs/maintainer-workflow.md index 223df5b..c666fc7 100644 --- a/docs/maintainer-workflow.md +++ b/docs/maintainer-workflow.md @@ -38,7 +38,7 @@ Below are key responsibilities and guidelines to help you manage the project eff 1. PR approval and merge - Contributors cannot merge PRs, assist them in the merging process. - Ensure Continuous Integration (CI) passes before merging, except for non-code/test changes. - - Approve CI builds for first time contributors. + - [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). 1. Labeling PRs - Stalebot ignores PRs labeled `awaiting-inputs`, `work-in-progress`, and `help-wanted`.