Add necessity to list all steps of a spec algorithm to style guide
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 42
- Forks
- 71
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 8
Description
Per https://github.com/servo/servo/issues/37022 we should be adding steps to relevant algorithms. This can be added to the style guide with some examples. Things to look out for:
- Are all steps listed, those unimplemented have a
// TODOon the next line - Steps ending with
. - If there is spec text that doesn't link to a particular step, is there a link where it can be found
Contributor guide
No contributing guide indexed for this repository
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 by locating the style guide referenced in the issue and review nearby algorithm guidance. Add examples covering complete step lists, TODO markers for unimplemented steps, sentence-ending periods, and links for specification text without a step link. Done means the style guide clearly documents all four checks.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100