[Docs idea] Best Practices - You May Not Need
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 20.8k
- Forks
- 2.3k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 156
Description
Describe the problem
there are some things that people tend to forget perhaps we could document in one place as a sort of checklist for people who may carry over assumptions from other frameworks
e.g. i am very used to importing axios or node-fetch when getting data. just realized that i can just use SK's inbuilt fetch and save me a lot of trouble.
Describe the proposed solution
a "You May Not Need" document with suggestions, e.g.
- You May Not Need node-fetch or axios, use
+page.jsand SK's providedfetch - You May Not Need error handling code if you can use
_error.jsorerror()
etc
Alternatives considered
some kind of linter?
Importance
nice to have
Additional Information
just proposing, happy to work on it but my list is pretty short right now, will come back to add when i think of anything
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 issue proposal and the existing documentation around +page.js, _error.js, error(), and the provided fetch. Identify where a best-practices checklist would fit and what existing guidance should be consolidated; done means an agreed "You May Not Need" document with verified, useful examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100