This is an automated email from the ASF dual-hosted git repository.
sergeychugunov pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ignite-3.git
The following commit(s) were added to refs/heads/main by this push:
new c2b00338ca IGNITE-19883 Pull request template with common code quality
checks added
c2b00338ca is described below
commit c2b00338ca52337e06540e78bd13cd0439ec897f
Author: Sergey Chugunov <[email protected]>
AuthorDate: Wed Aug 2 16:55:43 2023 +0400
IGNITE-19883 Pull request template with common code quality checks added
---
.github/PULL_REQUEST_TEMPLATE.md | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000000..e31ce5da18
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,19 @@
+Thank you for submitting the pull request.
+
+In order to streamline the review of the patch and ensure better code quality
+we ask both an author and a reviewer to check the following requirements:
+
+### The Review Checklist
+- [ ] **Formal criteria:** TC status, codestyle, mandatory documentation. Also
check the following list:
+\- There is a single JIRA ticket related to the pull request.
+\- The web-link to the pull request is attached to the JIRA ticket.
+\- The JIRA ticket has the Patch Available state.
+\- The description of the JIRA ticket explains WHAT and WHY was made and HOW.
+\- The pull request title is treated as the final commit message. The
following pattern must be used: IGNITE-XXXX Change summary where XXXX - number
of JIRA issue.
+- [ ] **Design:** new code conforms with the design principles of the
components it is added to.
+- [ ] **Patch quality:** patch cannot be split into a smaller pieces, its size
is reasonable.
+- [ ] **Code quality:** code is clean and readable, necessary developer
documentation is added if needed.
+- [ ] **Tests code quality:** tests set covers positive/negative scenarios,
happy/edge cases. Tests are effective in terms of execution time and resources.
+
+### Notes
+- [Apache Ignite Coding
Guidelines](https://cwiki.apache.org/confluence/display/IGNITE/Java+Code+Style+Guide)
\ No newline at end of file
