Documentation for `bash` and other similar commands
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
Its not clear how code interacts with command attributes if at all.
It appears that bash is a wrapper around script and script inherits attributes from the more generic execute resource.
- Is
commandinherited from higher scope resource? Or is it overridden to act differently bybashspecifcally? - if
codeis required, what different purpose doescommandserve? - if this is just a wrapper around the more generic
scriptperhaps this should be stated clearly and make references toscriptinstead ofexecuteresource?
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 data/infra/resources/bash.yaml at lines 50-64, then compare the documented bash, script, and execute resources. Determine how code and command relate and whether bash wraps script as described. Done means the documentation clearly answers the three questions and points to the correct related resource.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bash
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100