JavaScript style guide for documentation PRs
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation
Research direction
Start with the issue body and its 15-comment thread; no file or test is named. Determine whether the documentation PR style guide has a settled scope, then identify the documentation entry point and agree on the categories and examples that constitute completion.
Written by the indexing model from the issue text.
Description
@zachleat,
Can we drum up a quick style guide for vanilla JS code examples? I'm willing to forego my (otherwise highly opinionated) personal style for a standard.
I can mimic what's already there, but it'd be good to establish something formally—for consistency within the docs (if not also the codebase). Here are the major categories I'm thinking we could use some clear ground rules:
- Ternary operators v. conditional statements?
- Semicolon?
- Closures?
- Explicit
returnstatements? varv.constandlet?- Arrow functions v. declarations v. expressions?
- When and when not to cache variables
- Classes v.
exports.render - Comments and/or JSDoc blocks?
importv.require()this- Others?
I'm convinced more folks would reach for the vanilla 🍦 if they had more examples in the docs—and I wanna help.
- Dominant language
- Nunjucks
- Stars
- 547
- Forks
- 727
- Avg merge
- 7d 10h
- Merged PRs (30d)
- 3
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from 11ty/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Suggestion for pagination/"before" documentation: clarify that only js front matter is supportedOpen
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
Liquid "include" tag is deprecatedPossibly taken @darthmall claimed this 451 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Similar issues
-
good first issue quality
Difficulty 1/5 Under an hour Newbie friendliness 88/100
StudentSuite/awesome-student-resources#553 ·
Maintainers usually reply within 1 day
-
content good first issue
Difficulty 1/5 Under an hour Newbie friendliness 82/100
StudentSuite/awesome-skills-plugins-for-students#297 ·
Maintainers usually reply within 1 day
-
ready-for-agent wayfinder:task
Difficulty 2/5 Half a day Newbie friendliness 68/100
openaddr/dafung-web#401 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Link Checker ReportOpenautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 62/100