Re-enable `jsdoc/require-jsdoc`
Open
Nobody has claimed this yet.
team-core-platform
- Dominant language
- TypeScript
- Stars
- 413
- Forks
- 308
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 253
Description
The rule `jsdoc/require-jsdoc` was temporarily disabled because the auto-fixer doesn't work very well (it produced not-very-useful "stub" comment blocks that then violated a bunch of other rules without auto-fixers).
We can enable it one package at a time to break the work up.
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
Start by locating the package-specific lint configuration where `jsdoc/require-jsdoc` is disabled, then choose one package to enable it for. Run that package's lint checks and resolve the resulting documentation-rule violations; done means the rule is enabled without leaving stub comments that violate other rules.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, typescript
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100