Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve setup instructions #6156

Merged
merged 3 commits into from Sep 2, 2022
Merged

Conversation

edhgoose
Copy link
Contributor

@edhgoose edhgoose commented Aug 29, 2022

I visited Google to find the cli install instructions, and ended up following these steps:

  1. Link ends up on this repository (github.com/cli/cli)
  2. Scroll down to usage and installation instructions
  3. Click link to "see the manual" which visits https://cli.github.com/manual/
  4. Click on the link to see installation instructions, which ends up back at the readme here.

This little change makes it clearer the installation instructions are below. Wording improvement welcome!

@edhgoose edhgoose requested a review from a team as a code owner Aug 29, 2022
@edhgoose edhgoose requested review from samcoe (assigned from cli/code-reviewers) and removed request for a team Aug 29, 2022
@cliAutomation cliAutomation added the external pull request originating outside of the CLI core team label Aug 29, 2022
@cliAutomation
Copy link
Collaborator

cliAutomation commented Aug 29, 2022

Hi! Thanks for the pull request. Please ensure that this change is linked to an issue by mentioning an issue number in the description of the pull request. If this pull request would close the issue, please put the word 'Fixes' before the issue number somewhere in the pull request body. If this is a tiny change like fixing a typo, feel free to ignore this message.

@cliAutomation cliAutomation added this to Needs review 🤔 in The GitHub CLI Aug 29, 2022
@samcoe samcoe self-assigned this Aug 30, 2022
Copy link
Member

@samcoe samcoe left a comment

Thanks for helping improve our docs. I proposed a slight wording change, let me know what you think.

README.md Outdated Show resolved Hide resolved
@edhgoose
Copy link
Contributor Author

edhgoose commented Sep 2, 2022

Sounds good @samcoe - I've made that change.

samcoe
samcoe approved these changes Sep 2, 2022
Copy link
Member

@samcoe samcoe left a comment

Thanks for making the requested changes!

The GitHub CLI automation moved this from Needs review 🤔 to Needs to be merged 🎉 Sep 2, 2022
@samcoe samcoe enabled auto-merge (squash) Sep 2, 2022
@samcoe samcoe merged commit 5f52a1d into cli:trunk Sep 2, 2022
3 checks passed
The GitHub CLI automation moved this from Needs to be merged 🎉 to Pending Release 🥚 Sep 2, 2022
@github-actions github-actions bot moved this from Pending Release 🥚 to Done 💤 in The GitHub CLI Sep 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
external pull request originating outside of the CLI core team
Projects
The GitHub CLI
  
Done 💤
Development

Successfully merging this pull request may close these issues.

None yet

3 participants