search

aragon / AGPs

Aragon Goverance Proposals repository
Other
60 stars 50 forks source link

Errata fix to Stage IV finalization workflow #115

Closed john-light closed 4 years ago

john-light commented 4 years ago

Improving the Stage IV finalization workflow based on feedback in this thread: https://forum.aragon.org/t/call-for-an-emergency-vote-to-push-back-every-stage-of-anv4-by-1-week/1356

sohkai commented 4 years ago

My only comment is that it's really easy for someone to accidentally not mark their pull request as a draft, due to the Github UI, and there's no way to put it back into draft (yet). We may want to specify secondary measures, like adding the "Draft" prefix to the title, and sending a "Ready for review" message.

john-light commented 4 years ago

@sohkai thank you for your review! That is an edge case that I had not considered. I have added instructions to this PR to account for such cases. Let me know what you think :)

yeqbfgxjiq commented 4 years ago

After a proposal in Stage IV has been thoroughly reviewed, you may finalize your proposal by making any final changes and mark the pull request as "Ready to review", changing the draft pull request to a ready pull request. If you do not finalize the proposal and change the pull request from "draft" to "ready to review" before Stage V is scheduled to begin, AGP Editors will consider the proposal withdrawn and close the pull request when Stage V begins.*

It would help if the process of "marking" a proposal as draft or ready to review was specified. I believe you mean to say that one should add a comment to the PR stating that it is a draft, ready to review, or finalized and ready to move to stage v. As is, it sounds like it this process could involve adding an Issue tag or some other process. If you meant that users should added comments in the PR thread to "mark" AGPs, it would be helpful if AGP-1 just said to "add a comment in the AGP PR thread saying X" vs just saying "mark the AGP as X."

If the draft proposal was submitted as a ready pull request with [DRAFT] in the title as required in the Stage IV section above, then [DRAFT] should be removed from the title when the pull request is finalized and ready for review. If [DRAFT] is not removed from the pull request title before Stage V is scheduled to begin, then AGP Editors will consider the proposal withdrawn and close the pull request when Stage V begins.

This makes sense. If there is DRAFT in the title it is clearly a draft. Good call on specifying that authors need to remove that from the title.

yeqbfgxjiq commented 4 years ago

Thinking it through and this is still not intuitive... A pull request is a request to merge something into the repo. An Issue is where discussion around ideas happens. Why not just make Issues in the AGPs repo where proposals in stage III and IV go, and then have PRs be where people submit finalized proposals ready to be reviewed by AA and merged into the AGP repo if approved by ANT holders? That would make way more sense.

john-light commented 4 years ago

@burrrata

It would help if the process of "marking" a proposal as draft or ready to review was specified

It says:

you may finalize your proposal by making any final changes and mark the pull request as "Ready to review", changing the draft pull request to a ready pull request.

Emphasis mine. See: https://github.blog/2019-02-14-introducing-draft-pull-requests/

Why not just make Issues in the AGPs repo where proposals in stage III and IV go, and then have PRs be where people submit finalized proposals ready to be reviewed by AA and merged into the AGP repo if approved by ANT holders?

I see what you're saying but it is designed the way that it is because I want to keep AGPs all in the same place rather than spread out in multiple tabs. Also issues are awkward to collaborate on, whereas with PRs people can make suggestions directly in the PR text and authors can easily merge suggested changes in. The new workflow with Draft PRs and Ready PRs makes it even more unambiguous than it was before whether or not a PR is a draft or finalized.