Add test for missing service/RPC documentation
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1
- Forks
- 2
- Avg merge
- 5m
- Merged PRs (30d)
- 1
Description
In a recent conversation with @dragazo, the idea of adding an automated test for ensuring that all RPCs and services have documentation recently came up. This would be great to have and could be added to the services-worker test suite.
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 in the services-worker test suite and inspect existing tests plus the service and RPC definitions they exercise. Add coverage that detects undocumented services or RPCs, then run the relevant test command and confirm the suite fails for missing documentation and passes when all entries are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, testing
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100