X Tutup
Skip to content

Commit bb6a571

Browse files
committed
Tweak contributing guidelines
1 parent 20f88bb commit bb6a571

File tree

2 files changed

+8
-13
lines changed

2 files changed

+8
-13
lines changed

.github/CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Please do:
1111
* Open an issue to propose a significant change.
1212
* Open a pull request to fix a bug.
1313
* Open a pull request to fix documentation about a command.
14-
* Open a pull request for an issue with the [`help wanted`][] label and leave a comment claiming it.
14+
* Open a pull request for any issue with [`help wanted`][] or [`good first issue`][] labels.
1515

1616
Please avoid:
1717

@@ -54,6 +54,7 @@ We generate manual pages from source on every release. You do not need to submit
5454
[bug issues]: https://github.com/cli/cli/issues?q=is%3Aopen+is%3Aissue+label%3Abug
5555
[feature request issues]: https://github.com/cli/cli/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement
5656
[help wanted]: https://github.com/cli/cli/labels/help%20wanted
57+
[good first issue]: https://github.com/cli/cli/labels/good%20first%20issue
5758
[legal]: https://docs.github.com/en/free-pro-team@latest/github/site-policy/github-terms-of-service#6-contributions-under-repository-license
5859
[license]: ../LICENSE
5960
[code-of-conduct]: ./CODE-OF-CONDUCT.md

README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,15 @@
44

55
![screenshot of gh pr status](https://user-images.githubusercontent.com/98482/84171218-327e7a80-aa40-11ea-8cd1-5177fc2d0e72.png)
66

7-
## Availability
8-
9-
GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterprise Server 2.20+, and to install on macOS, Windows, and Linux.
10-
7+
GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterprise Server 2.20+, and to install on macOS, Windows, and Linux.
118

129
## Documentation
1310

14-
Read the [official docs][] for usage and more information.
15-
16-
17-
18-
## We want your feedback
11+
[See the manual][manual] for setup and usage instructions.
1912

20-
We'd love to hear your feedback about `gh`. If you spot bugs or have features that you'd really like to see in `gh`, please check out the [contributing page][].
13+
## Contributing
2114

15+
If anything feels off, or if you feel that some functionality is missing, please check out the [contributing page][contributing]. We'd love to hear your feedback!
2216

2317

2418
<!-- this anchor is linked to from elsewhere, so avoid renaming it -->
@@ -92,13 +86,13 @@ tools bring GitHub to the terminal, `hub` behaves as a proxy to `git`, and `gh`
9286
tool. Check out our [more detailed explanation][gh-vs-hub] to learn more.
9387

9488

95-
[official docs]: https://cli.github.com/manual
89+
[manual]: https://cli.github.com/manual/
9690
[Homebrew]: https://brew.sh
9791
[MacPorts]: https://www.macports.org
9892
[scoop]: https://scoop.sh
9993
[Chocolatey]: https://chocolatey.org
10094
[releases page]: https://github.com/cli/cli/releases/latest
10195
[hub]: https://github.com/github/hub
102-
[contributing page]: https://github.com/cli/cli/blob/trunk/.github/CONTRIBUTING.md
96+
[contributing]: ./.github/CONTRIBUTING.md
10397
[gh-vs-hub]: ./docs/gh-vs-hub.md
10498
[build from source]: ./docs/source.md

0 commit comments

Comments
 (0)
X Tutup