"$" in code examples in Readme prevents simple copy/paste
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 23.1k
- Forks
- 1.1k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 9
Description
Hi! First, huge fan of sops - this is a silly "non-issue" kind of nit, but I noticed that the code examples inconsistently had the shell prompt included so when you copy / paste blocks of code into your terminal (yes yes, not good form, always verify before hitting enter) the prompt would be there for some lines. I'd like to open a PR to remove those if that's alright. Cheers!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect the README code examples and identify blocks where the shell prompt is included inconsistently. Remove the "$" prompts so commands can be copied directly, then review the affected examples to confirm their formatting and meaning remain clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100