Extend description linter for static API members
Open
Beginner friendly
Nobody has claimed this yet.
infra
- Dominant language
- JSON
- Stars
- 5.8k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 186
Description
What type of issue is this?
Linter issue
What is the issue?
No lint failure when not providing a description for static API members.
Happened in https://github.com/mdn/browser-compat-data/pull/29474, for example.
What behavior were you expecting?
Lint failure like for _event features, see https://github.com/mdn/browser-compat-data/blob/main/lint/linter/test-descriptions.js
What version(s) of BCD is the issue present in?
- The current BCD release
- The current version of the
mainbranch
Do you have anything more you want to share?
No response
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 with lint/linter/test-descriptions.js and compare its existing _event feature checks with static API members. Trace the linter entry point that handles descriptions, then add coverage so static members without descriptions produce a lint failure. Run the linter tests and confirm the reported behavior matches the existing description checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 75/100