From 60e028505d8a492c39f72d265cf241774ce31f6b Mon Sep 17 00:00:00 2001 From: Kynan Ware <47394200+BagToad@users.noreply.github.com> Date: Thu, 6 Feb 2025 15:04:04 -0700 Subject: [PATCH 1/3] Doc: Clarify guidelines for `help wanted` issues and prs --- .github/CONTRIBUTING.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9a0acb58e..01772092d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,23 +4,25 @@ Hi! Thanks for your interest in contributing to the GitHub CLI! We accept pull requests for bug fixes and features where we've discussed the approach in an issue and given the go-ahead for a community member to work on it. We'd also love to hear about ideas for new features as issues. -Please do: +### Please do: -* Check issues to verify that a [bug][bug issues] or [feature request][feature request issues] issue does not already exist for the same problem or feature. -* Open an issue if things aren't working as expected. -* Open an issue to propose a significant change. -* Open an issue to propose a design for an issue labelled [`needs-design` and `help wanted`][needs design and help wanted], following the [proposing a design guidelines](#proposing-a-design) instructions below. -* Open a pull request to fix a bug. -* Open a pull request to fix documentation about a command. -* Open a pull request for any issue labelled [`help wanted`][hw] or [`good first issue`][gfi]. +* Check issues to verify that a [bug][bug issues] or [feature request][feature request issues] issue does not already exist for the same problem or feature +* Open an issue if things aren't working as expected +* Open an issue to propose a significant change +* Open an issue to propose a design for an issue labelled [`needs-design` and `help wanted`][needs design and help wanted], following the [proposing a design guidelines](#proposing-a-design) instructions below +* Mention `@cli/code-reviewers` when an issue you want to work on does not have clear Acceptance Criteria +* Open a pull request to fix a bug +* Open a pull request to fix documentation about a command +* Open a pull request for any issue labelled [`help wanted`][hw] or [`good first issue`][gfi] -Please avoid: +### Please _do not_: -* Opening pull requests for issues marked `needs-design`, `needs-investigation`, or `blocked`. -* Opening pull requests that haven't been approved for work in an issue -* Adding installation instructions specifically for your OS/package manager. -* Opening pull requests for any issue marked `core`. These issues require additional context from - the core CLI team at GitHub and any external pull requests will not be accepted. +* Open pull requests for issues marked `needs-design`, `needs-investigation`, or `blocked` +* Open pull requests that haven't been approved for work in an issue +* Expand pull request scope to include changes that are not described in the issue's Acceptance Criteria +* Add installation instructions specifically for your OS/package manager +* Open pull requests for any issue marked `core`. These issues require additional context from + the core CLI team at GitHub and any external pull requests will not be accepted ## Building the project From 5c6540bf59ba5d61f7fc0646e1ac6c4a0e69fd09 Mon Sep 17 00:00:00 2001 From: Kynan Ware <47394200+BagToad@users.noreply.github.com> Date: Fri, 7 Feb 2025 09:54:40 -0700 Subject: [PATCH 2/3] Remove redundant instructions --- .github/CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 01772092d..f819793f0 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -11,8 +11,6 @@ We accept pull requests for bug fixes and features where we've discussed the app * Open an issue to propose a significant change * Open an issue to propose a design for an issue labelled [`needs-design` and `help wanted`][needs design and help wanted], following the [proposing a design guidelines](#proposing-a-design) instructions below * Mention `@cli/code-reviewers` when an issue you want to work on does not have clear Acceptance Criteria -* Open a pull request to fix a bug -* Open a pull request to fix documentation about a command * Open a pull request for any issue labelled [`help wanted`][hw] or [`good first issue`][gfi] ### Please _do not_: From fa39aa7e5e0ab18c5eff8ee8103b40b5c9f40ef9 Mon Sep 17 00:00:00 2001 From: Kynan Ware <47394200+BagToad@users.noreply.github.com> Date: Fri, 7 Feb 2025 09:56:14 -0700 Subject: [PATCH 3/3] Collapse related instructions --- .github/CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f819793f0..5bb8e43db 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -15,8 +15,7 @@ We accept pull requests for bug fixes and features where we've discussed the app ### Please _do not_: -* Open pull requests for issues marked `needs-design`, `needs-investigation`, or `blocked` -* Open pull requests that haven't been approved for work in an issue +* Open a pull request for issues without the `help wanted` label or explicit Acceptance Criteria * Expand pull request scope to include changes that are not described in the issue's Acceptance Criteria * Add installation instructions specifically for your OS/package manager * Open pull requests for any issue marked `core`. These issues require additional context from