Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Review guidelines (markdown)

Jirka Borovec 2020-05-12 22:17:47 +02:00
parent 6682939a40
commit b53a9a4a0f
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Review-guidelines.md

@ -4,7 +4,12 @@ Some recommended steps for reviewing open PRs.
2. Read the changes if they are aligned with our code-base
3. Check if the changes (fixed issue, new feature) are **covered by tests**
4. Check if the change is mentioned in **CHANGELOG** (no need for typos, docs and CI)
5. If you checked all the above points, you may approve the PR in your review or request changes. Only approve it if you are confident that the issue or feature is fully addressed, otherwise leave a comment with your concerns. Note that if you approve and the PR reaches the minimum number of required approvals, and given that all tests pass, the branch will be automatically merged into master.
5. If you checked all the above points, you may approve the PR in your review or request changes. Only approve it if you are confident that the issue or feature is fully addressed, otherwise leave a comment with your concerns. The actual `mergify` automation is set for N approvals so each approval matter and you shall be confident with your action... the rule of the tongue says:
- Approve: if you completely agree with the content to be merged as it is now (no extra condition in comments)
- Comment: not sure in any direction (your understanding, affect in global, etc.) but you want to express your opinion about a specific point
- Request changes: if you are sure that the actual change will break something or has obvious issues
Remember that if you approve a PR and it reaches the minimum number of required approvals and given that all tests pass, the branch will be automatically merged into master.
## Hints and remarks