From 19dfc12fdf9470461befac39da37e2779064e513 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Mon, 22 Mar 2021 10:44:38 +0100 Subject: [PATCH] Add general tips --- review_checklist.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/review_checklist.md b/review_checklist.md index 6da0deb..66e5f6c 100644 --- a/review_checklist.md +++ b/review_checklist.md @@ -2,7 +2,13 @@ When reviewing, keep in mind that we follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all our contributions and interactions within this repository. -If your suggestion in a review comment is optional or a matter of personal preferences, please say it. +**General tips** +- Try create a culture of collaboration, when reviewing +- Welcome the author, thank them and other reviewers for their time and effort +- When suggesting changes, try to use questions, not statements +- When suggesting mandatory changes, do it as politely as possible providing documentation references +- If your suggestion is optional or a matter of personal preferences, please say it explicitly +- When asking for adding tests or for complex core refactoring, say that the author is welcome to ask for clarifications and help if they need **Standards and documentation** - [ ] the pull request is not a documentation fix, it must include a [changelog fragment](https://docs.ansible.com/ansible/devel/community/development_process.html#creating-a-changelog-fragment). Please check the format carefully