semantic-release / semantic-release/commit-analyzer
Incorrect JSDoc Type
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 448
- Forks
- 82
- Avg merge
- 17h 41m
- Merged PRs (30d)
- 4
Description
The return type of analyzeCommits is declared as String|null in the JSDoc header. However, analyzeCommits is an async function. Return type should be Promise<String|null> instead.
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
Open index.js at lines 12-26 and inspect the JSDoc header for analyzeCommits. Update the documented return type to reflect the async function, then confirm the annotation matches the issue’s requested Promise<String|null> type.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- release
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100