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

chore(readme): update install code fences #614

Merged
merged 1 commit into from
Oct 13, 2023
Merged

chore(readme): update install code fences #614

merged 1 commit into from
Oct 13, 2023

Conversation

greyscaled
Copy link
Contributor

@greyscaled greyscaled commented Oct 13, 2023

👋🏻 Hey friends, I enjoy using this project, and thought I'd push up a slightly opinionated take on the install scripts in the Readme.

The story:

I often go to the readme and press the copy to clipboard button that GitHub renders:

copy-to-clipboard

and then paste it into my terminal. However, this adds a preceeding $, which causes the command to fail:

$ $ go install github.com/pressly/goose/v3/cmd/goose@latest
$: command not found

The change:

The change adds a code fence with the shell language, which (at least on my browser and os) looks idential in the GH UI, but when I copy the command to the clipboard, I can use it without modification.

To see what it looks like, here's the link to the install section in my fork: https:/greyscaled/goose#install

and a side-by-side (original left, my fork right):

side-by-side

LMK what you think, thanks!

This is a quality-of-life change for clicking the "copy clipboard"
button in GitHub UI.
Copy link
Collaborator

@mfridman mfridman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes perfect sense to me. Thanks for giving goose a try and contributing 🎉

@mfridman mfridman merged commit fe8fe97 into pressly:master Oct 13, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants