silverstripe / silverstripe/developer-docs
Review best practice docs for JS and CSS
Open
Nobody has claimed this yet.
affects/v4
affects/v5
type/docs
- Dominant language
- No language data
- Stars
- 7
- Forks
- 74
- Avg merge
- 1d 14m
- Merged PRs (30d)
- 6
Description
Spun off from https://github.com/silverstripe/developer-docs/issues/323
Review best practice docs for
Acceptance criteria
- A list of best practices has been establish and make general consensus among core committers and the team.
- The page(s) make clear that best practices can be overridden in individual circumstances and are not hard rules.
- Best practices are aimed towards both core modules and bespoke projects.
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 by reviewing the JavaScript and SCSS best-practice pages linked in the issue, then read the spun-off issue #323 for context. Compare the current guidance with agreed practices and seek consensus from core committers and the team. Done means both pages cover core modules and bespoke projects, clearly describe exceptions, and reflect that consensus.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, scss
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100