search

ReviewNB / support

Issues and feature requests for ReviewNB
https://reviewnb.com
59 stars 8 forks source link

[Feature Request] Support suggestions #109

Closed muellerzr closed 2 years ago

muellerzr commented 2 years ago

One of the big blockers towards adopting nbdev in companies through Github is the inability to provide and accept reviewer changes on notebooks.

If this could be implemented, many companies would feel more at ease reviewing them, and systems such as nbdev can get more widespread use.

amit1rrr commented 2 years ago

Hello @muellerzr Thank you for the feature request.

By suggestions you mean, GitHub like workflow where reviewer can suggest a change that the PR author can accept / reject with a single click. Is my understanding correct?

You mentioned nbdev a couple of times, how is that related to this feature request? Am I missing something here?

muellerzr commented 2 years ago

Correct, exactly that!

nbdev is an entire literate programming framework revolving around using jupyter notebooks to build software libraries. Having this be a functionality in reviewnb reduces the differences/losses between reviewing a notebook and reviewing raw source code helping bridge more of this gap in Github.

I believe this can be bootstrapped into the github API in some form (I've looked at it quite a bit thanks to GhApi), was debating on toying with it though to just see how that would end up looking.

(Might be something like ReviewNB makes the actual push to the repo and commits that code)

muellerzr commented 2 years ago

Some other useful nbdev-related libs they have include:

I'll also add on that if it's an nbdev project usually one pairs it with ReviewNB OOTB, such as with fastai. Adding this suggestion capability would only bolster its usage!

amit1rrr commented 2 years ago

Got it, thanks!

I agree that this would be a good addition to ReviewNB. As I mentioned on this issue the primary blocker is that we do not ask for write permission on the repository. So we're not able to push any commits to the repository.

The alternative here is to comment on a particular line and write suggested changes in the comment. Reviewer can then copy-paste this suggestion. While this is not ideal, it's not too cumbersome either.

muellerzr commented 2 years ago

@amit1rrr if we can get that far we can (probably even) bootstrap our own stuff in nbdev to take it to that last stage 😄

That'd be amazing!

amit1rrr commented 2 years ago

if it's an nbdev project usually one pairs it with ReviewNB OOTB, such as with fastai.

Nice to hear that :) Look forward to the release of nbprocess!