Tools Workflow
Contributing Tools
When adding new tools to /tools
:
- Choose the appropriate functional subdirectory (ask in issue if unclear)
- Required: Implement
--help
flag for self-documentation - Follow naming conventions (see tools guidelines)
- Update the subdirectory's README.md to categorize the tool type
Tool Documentation Philosophy
- Scripts are self-documenting with
--help
flags - README.md files categorize what types of tools belong in each folder
- Users get immediate help:
./tool.sh --help
- No external documentation required for tool usage