OpenFreeEnergy / OpenFreeEnergy/openfe
cli: external tool discoverability
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 331
- Forks
- 56
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 13
Description
Define how the auto-documentation of yaml files will behave.
Should define
- how help is requested by user
- what help is provided by programs
- how tools can define their available help messages
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 the issue's three questions about requesting help, program-provided help, and tool-defined help messages. No files or tests are named, so first locate the CLI and YAML auto-documentation entry points; done means the behavior and interface for all three cases are clearly specified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100