Documentation
README
Ensure the handler and tests for $ARGUMENTS provide comprehensive coverage.
1. Gather Documentation
Find documentation for the tool (need at least one source):
tldr:
ls ~/source/tldr/pages/*/$ARGUMENTS*.md
cat ~/source/tldr/pages/*/$ARGUMENTS.md
Local CLI:
$ARGUMENTS --help
man $ARGUMENTS
Stop if neither source exists.
2. Explore Subcommands
For tools with subcommands, recursively explore:
$ARGUMENTS <subcommand> --help
$ARGUMENTS help <subcommand>
Build a mental model of:
- All subcommands and their actions
- Which operations are read-only (safe) vs mutate state (unsafe)
- Global flags that affect parsing
- Edge cases
3. Review Existing Tests
This is the opening of the README. Read the full README on GitHub.