Add comments for playground examples
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 142
- Forks
- 230
- PR merge metrics
- No merged PRs in 30d
Description
Because there's no external explanation for the playground examples added in https://github.com/PolymerLabs/lit.dev/pull/130, we should probably add comments to these code examples.
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 playground examples introduced in pull request 130 and identify which examples lack explanatory comments. Add comments that explain the examples for readers without external context; done means the relevant examples are understandable from the code itself.
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
- 52/100