options review
Open
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 200
- Forks
- 85
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 2
Description
related to #272 , I would like to improve the way tool options are documented and validated. There are a number of activities to make this happen:
- validate the tools by hand, just to make sure our release is good.
- create developer documentation around the canonical place for option documentation (man page, help text, other).
- create a tool to audit the man page, help text, and getopt parsing.
- add this tool to the CI tests.
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 related issue #272 and inspect the existing man pages, help text, and getopt parsing for the tools. The work is done when the canonical option documentation is documented, an audit tool compares these sources, and that audit runs in CI.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- ci-cd, documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100