9elements / 9elements/firmware-action
Document how to move complex build commands into scripts
Open
Nobody has claimed this yet.
documentation
low_priority
- Dominant language
- Go
- Stars
- 22
- Forks
- 1
- Avg merge
- 10h 8m
- Merged PRs (30d)
- 9
Description
The initial approach was: #518 and #519
But this gets way too complex.
We agreed to instead instruct the user in documentation to write a shell scripts. This would be much less painful.
So in documentation we should describe how to do that.
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
Review the approach described in issues #518 and #519, then locate the documentation covering complex build commands. Document how users can move those commands into shell scripts; the work is done when the documentation clearly explains that workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100