Improve documentation for review and merge processes #11800
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sija
reviewed
Feb 4, 2022
Co-authored-by: Sijawusz Pur Rahnama <[email protected]>
oprypin
approved these changes
Feb 26, 2022
beta-ziliani
reviewed
Mar 7, 2022
Co-authored-by: Beta Ziliani <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch enhances documentation for the approval process. It's clearly split into review, accept and merge stages.
I've tried to formalize the current non-codified customs as good as possible. The checks before accepting a PR and adding it to the merge queue is not fully in practice, currently. But I think it makes sense to do it at this point instead of later in the process (i.e. directly before merge).
None of this is set in stone, though. It's just a proposal and we can iterate on improving the processes.
Preview: https://github.com/straight-shoota/crystal/blob/feature/contrib-merge-process/CONTRIBUTING.md#reviews