manifoldco / manifoldco/torus-cli
Style guide - Successful, failure, error states
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 603
- Forks
- 30
- PR merge metrics
- No merged PRs in 30d
Description
Talking points
- Complex error messages
- Error message plus description
- Successful states contain output or not?
- In a lot of system tools no output is the success state
- Most of our commands now provide a confirmation message
- Invalid usage? validation failure?
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
Start with the talking points in this issue and review the existing command-output conventions in torus-cli. Define guidance for success, failure, error, invalid-usage, and validation messages, including when commands should be silent; done means the agreed rules are captured as a style guide.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100