Skip to content

Commit 022d29c

Browse files
author
Sam Coe
committed
Further cleanup up README links and update contributing doc
1 parent a8add83 commit 022d29c

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ We accept pull requests for bug fixes and features where we've discussed the app
1010

1111
Please do:
1212

13+
* check existing issues to verify that the bug or feature request has not already been submitted
1314
* open an issue if things aren't working as expected
1415
* open an issue to propose a significant change
1516
* open a pull request to fix a bug

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ While in beta, GitHub CLI is available for repos hosted on GitHub.com only. It c
1111

1212
## We want your feedback
1313

14-
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 open an [issue][] and check out the [contributing page][].
14+
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][].
1515

1616
## Usage
1717

@@ -30,7 +30,7 @@ Read the [official docs][] for more information.
3030
For many years, [hub][] was the unofficial GitHub CLI tool. `gh` is a new project that helps us explore
3131
what an official GitHub CLI tool can look like with a fundamentally different design. While both
3232
tools bring GitHub to the terminal, `hub` behaves as a proxy to `git`, and `gh` is a standalone
33-
tool. Check out our [more detailed explanation][] to learn more.
33+
tool. Check out our [more detailed explanation][gh-vs-hub] to learn more.
3434

3535

3636
<!-- this anchor is linked to from elsewhere, so avoid renaming it -->
@@ -135,7 +135,7 @@ Install and upgrade:
135135

136136
### Arch Linux
137137

138-
Arch Linux users can install from the [community repo][]:
138+
Arch Linux users can install from the [community repo][arch linux repo]:
139139

140140
```bash
141141
pacman -S github-cli
@@ -155,15 +155,14 @@ Download packaged binaries from the [releases page][].
155155

156156
### Build from source
157157

158-
See here on how to [build GitHub CLI from source][].
158+
See here on how to [build GitHub CLI from source][build from source].
159159

160160
[official docs]: https://cli.github.com/manual
161161
[scoop]: https://scoop.sh
162162
[Chocolatey]: https://chocolatey.org
163163
[releases page]: https://github.com/cli/cli/releases/latest
164164
[hub]: https://github.com/github/hub
165165
[contributing page]: https://github.com/cli/cli/blob/trunk/.github/CONTRIBUTING.md
166-
[issue]: https://github.com/cli/cli/issues/new/choose
167-
[more detailed explanation]: /docs/gh-vs-hub.md
168-
[community repo]: https://www.archlinux.org/packages/community/x86_64/github-cli/
169-
[build GitHub CLI from source]: /docs/source.md
166+
[gh-vs-hub]: /docs/gh-vs-hub.md
167+
[arch linux repo]: https://www.archlinux.org/packages/community/x86_64/github-cli
168+
[build from source]: /docs/source.md

0 commit comments

Comments
 (0)