Revisit code formatting for `/packages/lit-dev-content/samples/`
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 142
- Forks
- 230
- PR merge metrics
- No merged PRs in 30d
Description
There are a couple of code formatting issues in the cheat sheet. (e.g. inconsistent spacing, missing newlines)
The packages/lit-dev-content/samples directory was prettier ignored in https://github.com/lit/lit.dev/pull/560.
In a fix-twice fashion, let's try to revisit prettier so that added content is consistently formatted.
(discussed in lit eng. meeting on April 10th, I'll work on it in the coming days)
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 in packages/lit-dev-content/samples/ and review the Prettier ignore change from pull request 560, then inspect the linked cheat-sheet examples for the spacing and newline issues. Check how formatting is currently configured for this directory. Done means the samples are consistently formatted and newly added content is covered by the formatting setup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100