community.mysql/review_checklist.md

Review Checklist

When reviewing, keep in mind that we follow Ansible Code of Conduct in all our contributions and interactions within this repository.

General tips

• Try create a culture of collaboration, when reviewing
• Welcome the author and thank them for the pull request
• 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 code refactoring, say that the author is welcome to ask for clarifications and help if they need
• If somebody suggests a good idea, say about it or put a thumbs up
• After merging, thank the author and reviewers for their time and effort

Standards and documentation

• if the pull request is not a documentation fix, it must include a changelog fragment. Please check the format carefully
• if new files are added with the pull request, they follow the licensing rules
• the changes follow the Ansible documentation standards and the style guide
• follow development conventions
• if a new plugin is added, it is one of the allowed plugin types
• documentation, examples, and return sections use FQCNs for M(..) when referencing to modules
• modules (or plugins) from ansible-core use ansible.builtin. as a FQCN prefix
• when a new option, module, plugin, or return value is added, the corresponding documentation or return sections use version_added: containing the collection version for which they were added
• FQCNs is used for extends_documentation_fragment:, unless the author is referring to doc_fragments from ansible-base

Tests (if applicable and possible to implement):

• the pull request has integration tests
• the pull request has unit tests
• all changes are covered
• integration tests also cover check_mode
• integration tests check an actual state of the system, not only what the module reports (for example, if the module change a file, check that the file was actually changed by using the ansible.builtin.stat module)

Other

• the pull request does not contain merge commits (see GitHub warnings at the bottom of the pull request)
• if the pull request contains breaking changes, ask the author if it is really needed and there is no way not to introduce them