Expand on our goal `help` strings.
Open
Nobody has claimed this yet.
bug
- Dominant language
- Python
- Stars
- 3.8k
- Forks
- 724
- Avg merge
- 4d 6h
- Merged PRs (30d)
- 19
Description
Describe the bug
Right now, our goal strings can be pretty short:
fmt: "Autoformat source code."lint: "Run all linters and/or formatters in check mode."
This may be true to definition, but isn't very well... _help_ful 😄
Pants version
main
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 by locating the goal help strings for fmt and lint in the Pants source. Review how these strings are presented to users, then expand them so the goals are more helpful while preserving their stated meaning. Done means both examples have clearer user-facing help text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100