mattdesl / mattdesl/module-best-practices
Best practice for private data setting.
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.5k
- Forks
- 89
- PR merge metrics
- No merged PRs in 30d
Description
In my sight, below code is errorous, when opt.foo's value is boolean.
``` javascript
// private data
var foo = opt.foo || 'default'
```
Contributor guide
No contributing guide indexed for this repository
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
Locate the best-practice example containing the “private data” comment and review how it handles opt.foo when the value is boolean. Update the example so a false value is not replaced by the default, then check the surrounding documentation for consistency; no specific file or test is named.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100