UX: unify the use of grammatical number for logs and showlog
Open
Nobody has claimed this yet.
kind/cleanup
- Dominant language
- Go
- Stars
- 461
- Forks
- 277
- Avg merge
- 16h 48m
- Merged PRs (30d)
- 95
Description
Version and Operating System
tkn Version:
0.7.1
Operating System:
Expected Behavior
The same concept is named in the same way
Actual Behavior
Multiple commands have a subcommand logs (plural, e.g. tkn task -h) but subcommand start has a parameter --showlog (singular, e.g. tkn task start -h) which is not user-friendly.
Steps to Reproduce the Problem
Additional Info
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
Compare the logs subcommands shown in tkn task -h with the --showlog parameter shown by tkn task start -h. Confirm the preferred grammatical form in the surrounding CLI help and tests, then update the naming consistently and verify both help outputs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100