matrix-org / matrix-org/matrix-hookshot
Third parameter of `setPRReviewData()` is unclear
Open
Nobody has claimed this yet.
T-Task
- Dominant language
- TypeScript
- Stars
- 450
- Forks
- 95
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 23
Description
The function `setPRReviewData` has a pretty unclear third parameter.
I've found the following names and types being used:
* `data: any`
* `data: string`
* `url: string`
* `event.subject as CachedReviewData`
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
Locate setPRReviewData and inspect the four usages represented in the issue: data as any, data as string, url as string, and event.subject as CachedReviewData. Compare the call sites to establish the intended third-parameter contract; done means the parameter's name and type are consistent or clearly documented across those usages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100