github-tools / github-tools/github
Add support for listing Review Comments on a Pull Request
- Dominant language
- JavaScript
- Stars
- 3.8k
- Forks
- 809
- PR merge metrics
- No merged PRs in 30d
Description
Currently it's only possible with this library to list comments on an issue, but those are not the same as "Review Comments" on a PR.
See Github's documentation on [Review Comments](https://developer.github.com/v3/pulls/comments/) vs [Comments](https://developer.github.com/v3/issues/comments/):
> Pull Request Review Comments are comments on a portion of the unified diff. These are separate from Commit Comments (which are applied directly to a commit, outside of the Pull Request view), and Issue Comments (which do not reference a portion of the unified diff).
In order to list review comments on a Pull Request, you need to make a call to
`GET /repos/:owner/:repo/pulls/:number/comments`
versus the call for regular issue comments which is
`GET /repos/:owner/:repo/issues/:number/comments`
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the library entry point that lists issue comments and compare its request to GET /repos/:owner/:repo/pulls/:number/comments. Add the corresponding way to list pull-request review comments, then verify that it uses the review-comments endpoint rather than the issue-comments endpoint.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100