[Feature Request] Summary Review Comment

ReviewNB / support

Issues and feature requests for ReviewNB

https://reviewnb.com

59 stars 8 forks source link

[Feature Request] Summary Review Comment #39

Closed alanhdu closed 3 years ago

alanhdu commented 5 years ago

In Github's code review interface, you are able to leave line-by-line comments, along with a general comment summarizing the overall review. I'd love to be able to have that "overall comment" feature for ReviewNB too! Right now, all comments (I think?) have to be attached to different parts of the notebook, but sometimes I want to give some overall suggestions/comments on the organization or logic of the notebook.

amit1rrr commented 5 years ago

@alanhdu - we do have issue comments that are meant to discuss overall changes. You can write these comments directly from the 'Discussion' tab in the PR.

Let me know if this is something you were looking for.

alanhdu commented 5 years ago

@amit1rrr There's the overall discussion page, but those aren't "bundled" into the same review as the cell-by-cell comments. In Github, there is:

which lets you submit a summary comment over the entire commit. This has two nice properties:

From a UI perspective, you don't need to switch tabs when composing the overall comment
From a Github perspective, the PR author only receives 1 notification (for the entire review) instead of 2 (one for the cell-by-cell review, one for the unattached comment)

amit1rrr commented 5 years ago

Yep, I'm aware of the overall comment that's attached to the review itself. I intentionally left it out of ReviewNB because it felt like the need for overall PR comment is well served by Issue Comments under the Discussion tab. The downside of tying it to every review in the UI is, somehow it feels like writing an overall message is required/encouraged with every review.

But there are definitely some niceties like single notification as you mentioned. So maybe I'm wrong. Let's keep this feature request open for some more upvotes. If multiple people find it useful, I'm open to adding this feature.

All Readers - If you find it useful to write overall review message with your reviews. Please upvote @alanhdu's comment above.

amit1rrr commented 3 years ago

Closing. This is now moved to #78