STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Tweak contributing guidelines

Browse source
This commit is contained in:
Mislav Marohnić 2020-10-13 16:40:40 +02:00
parent 20f88bbd5a
commit bb6a571ab5
2 changed files with 8 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.github/CONTRIBUTING.md vendored
View file

@ -11,7 +11,7 @@ Please do:
* Open an issue to propose a significant change.
* Open a pull request to fix a bug.
* Open a pull request to fix documentation about a command.
* Open a pull request for an issue with the [`help wanted`][] label and leave a comment claiming it.
* Open a pull request for any issue with [`help wanted`][] or [`good first issue`][] labels.
Please avoid:
@ -54,6 +54,7 @@ We generate manual pages from source on every release. You do not need to submit
[bug issues]: https://github.com/cli/cli/issues?q=is%3Aopen+is%3Aissue+label%3Abug
[feature request issues]: https://github.com/cli/cli/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement
[help wanted]: https://github.com/cli/cli/labels/help%20wanted
[good first issue]: https://github.com/cli/cli/labels/good%20first%20issue
[legal]: https://docs.github.com/en/free-pro-team@latest/github/site-policy/github-terms-of-service#6-contributions-under-repository-license
[license]: ../LICENSE
[code-of-conduct]: ./CODE-OF-CONDUCT.md

18
README.md
View file

@ -4,21 +4,15 @@
![screenshot of gh pr status](https://user-images.githubusercontent.com/98482/84171218-327e7a80-aa40-11ea-8cd1-5177fc2d0e72.png)
## Availability
GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterprise Server 2.20+, and to install on macOS, Windows, and Linux.
GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterprise Server 2.20+, and to install on macOS, Windows, and Linux.
## Documentation
Read the [official docs][] for usage and more information.
[See the manual][manual] for setup and usage instructions.
## Contributing
## We want your feedback
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][].
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!
<!-- 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`
tool. Check out our [more detailed explanation][gh-vs-hub] to learn more.
[official docs]: https://cli.github.com/manual
[manual]: https://cli.github.com/manual/
[Homebrew]: https://brew.sh
[MacPorts]: https://www.macports.org
[scoop]: https://scoop.sh
[Chocolatey]: https://chocolatey.org
[releases page]: https://github.com/cli/cli/releases/latest
[hub]: https://github.com/github/hub
[contributing page]: https://github.com/cli/cli/blob/trunk/.github/CONTRIBUTING.md
[contributing]: ./.github/CONTRIBUTING.md
[gh-vs-hub]: ./docs/gh-vs-hub.md
[build from source]: ./docs/source.md