You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+17-18Lines changed: 17 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,28 +4,27 @@ Hi! Thanks for your interest in contributing to the GitHub CLI!
4
4
5
5
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.
6
6
7
-
Please do:
7
+
### Please do:
8
8
9
-
* 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.
10
-
* Open an issue if things aren't working as expected.
11
-
* Open an issue to propose a significant change.
12
-
* 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.
13
-
* Open a pull request to fix a bug.
14
-
*Open a pull request to fix documentation about a command.
15
-
* Open a pull request for any issue labelled [`help wanted`][hw]or[`good first issue`][gfi].
9
+
* 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
10
+
* Open an issue if things aren't working as expected
11
+
* Open an issue to propose a significant change
12
+
* 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
13
+
* Open an issue to propose a new community supported `gh` package with details about support and redistribution
14
+
*Mention `@cli/code-reviewers` when an issue you want to work on does not have clear Acceptance Criteria
15
+
* Open a pull request for any issue labelled [`help wanted`][hw]and[`good first issue`][gfi]
16
16
17
-
Please avoid:
17
+
### Please _do not_:
18
18
19
-
* Opening pull requests for issues marked `needs-design`, `needs-investigation`, or `blocked`.
20
-
* Opening pull requests that haven't been approved for work in an issue
21
-
* Adding installation instructions specifically for your OS/package manager.
22
-
* Opening pull requests for any issue marked `core`. These issues require additional context from
23
-
the core CLI team at GitHub and any external pull requests will not be accepted.
19
+
* Open a pull request for issues without the `help wanted` label or explicit Acceptance Criteria
20
+
* Expand pull request scope to include changes that are not described in the issue's Acceptance Criteria
21
+
* Open pull requests for any issue marked `core`. These issues require additional context from
22
+
the core CLI team at GitHub and any external pull requests will not be accepted
24
23
25
24
## Building the project
26
25
27
26
Prerequisites:
28
-
- Go 1.22+
27
+
- Go 1.24+
29
28
30
29
Build with:
31
30
* Unix-like systems: `make`
@@ -63,9 +62,9 @@ To propose a design:
63
62
- Include a link to the issue that the design is for.
64
63
- Describe the design you are proposing to resolve the issue, leveraging the [CLI Design System][].
65
64
- Mock up the design you are proposing using our [Google Docs Template][] or code blocks.
66
-
- Mock ups should cleary illustrate the command(s) being run and the expected output(s).
65
+
- Mock ups should clearly illustrate the command(s) being run and the expected output(s).
67
66
68
-
### (core team only) Revewing a design
67
+
### (core team only) Reviewing a design
69
68
70
69
A member of the core team will [triage](../docs/triage.md) the design proposal. Once a member of the core team has reviewed the design, they may add the [`help wanted`][hw] label to the issue, so a PR can be opened to provide the implementation.
71
70
@@ -87,5 +86,5 @@ A member of the core team will [triage](../docs/triage.md) the design proposal.
87
86
[How to Contribute to Open Source]: https://opensource.guide/how-to-contribute/
0 commit comments