From 0967c0cc8161d86ab3427e22b91b3a2e5d76be43 Mon Sep 17 00:00:00 2001 From: Ronja <79447937+ronja-ui@users.noreply.github.com> Date: Wed, 4 Sep 2024 14:38:48 +0300 Subject: [PATCH 1/4] Create pull_request_template.md Added PR template --- .../pull_request_template.md | 65 +++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..67d7437 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,65 @@ +## Description + + + + + +## Checklists + + + +### Testing + +#### General + +- [ ] I have checked that my test files and functions have meaningful names. +- [ ] I have checked that each test tests only a single behavior. +- [ ] I have done happy tests. +- [ ] I have tested only my own code. +- [ ] I have tested at least all public methods. + +#### Assertions + +- [ ] I have checked that my tests use assertions and not runtime overhead. +- [ ] I have checked that my tests end in assertions. +- [ ] I have checked that there is no comparison statements in assertions. +- [ ] I have checked that assertions are in tests and not in helper functions. +- [ ] I have checked that assertions for iterables are outside of for loops and both sides of the iteration blocks. +- [ ] I have checked that assertions are not tested inside consumers. + +#### Testing Data + +- [ ] I have tested algorithms and anything else with the possibility of unbound growth. +- [ ] I have checked that all testing data is local and fully replaceable or reproducible or both. +- [ ] I have checked that all test files are standalone. +- [ ] I have checked that all test-specific fake objects and classes are in the test directory. +- [ ] I have checked that my tests do not contain anything related to customers, infrastructure or users. +- [ ] I have checked that my tests do not contain non-generic information. +- [ ] I have checked that my tests do not do external requests and are not privately or publicly routable. + +#### Statements + +- [ ] I have checked that my tests do not use throws for exceptions. +- [ ] I have checked that my tests do not use try-catch statements. +- [ ] I have checked that my tests do not use if-else statements. + +#### Java + +- [ ] I have checked that my tests for Java uses JUnit library. +- [ ] I have checked that my tests for Java uses JUnit utilities for parameters. + +#### Other + +- [ ] I have only tested public behavior and not private implementation details. +- [ ] I have checked that my tests are not (partially) commented out. +- [ ] I have checked that hand-crafted variables in assertions are used accordingly. +- [ ] I have tested [Object Equality](https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html#equals%28java.lang.Object%29). +- [ ] I have checked that I do not have any manual tests or I have a valid reason for them and I have explained it in the PR description. + +### Code Quality + +- [ ] I have checked that my code follows metrics set in Procedure: Class Metrics. +- [ ] I have checked that my code follows metrics set in Procedure: Method Metrics. +- [ ] I have checked that my code follows metrics set in Procedure: Object Quality. +- [ ] I have checked that my code does not have any NULL values. +- [ ] I have checked my code does not contain FIXME or TODO comments. From 04f02b05718530b5a1a023e535aa96dce7e2643d Mon Sep 17 00:00:00 2001 From: Ronja <79447937+ronja-ui@users.noreply.github.com> Date: Tue, 24 Sep 2024 13:48:45 +0300 Subject: [PATCH 2/4] Update pom.xml excluded pull request directory in pom.xml --- pom.xml | 1 + 1 file changed, 1 insertion(+) diff --git a/pom.xml b/pom.xml index 005846e..e30d089 100644 --- a/pom.xml +++ b/pom.xml @@ -162,6 +162,7 @@ .github/workflows/* .github/ISSUE_TEMPLATE/* + .github/PULL_REQUEST_TEMPLATE/* toolchains.xml settings.xml From 8ec284e80bc3f6ef0d35ef6605f7cbf8282546de Mon Sep 17 00:00:00 2001 From: Ronja <79447937+ronja-ui@users.noreply.github.com> Date: Mon, 7 Apr 2025 10:37:27 +0300 Subject: [PATCH 3/4] Rename .github/PULL_REQUEST_TEMPLATE/pull_request_template.md to .github/pull_request_template.md one directory up so the template starts to work --- .github/{PULL_REQUEST_TEMPLATE => }/pull_request_template.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/{PULL_REQUEST_TEMPLATE => }/pull_request_template.md (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/pull_request_template.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE/pull_request_template.md rename to .github/pull_request_template.md From 0cd2031c4885475ce0c34186281079b693c32045 Mon Sep 17 00:00:00 2001 From: Ronja <79447937+ronja-ui@users.noreply.github.com> Date: Mon, 7 Apr 2025 10:38:27 +0300 Subject: [PATCH 4/4] Update pom.xml updated pr template exclude --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index e30d089..9e7975f 100644 --- a/pom.xml +++ b/pom.xml @@ -162,7 +162,7 @@ .github/workflows/* .github/ISSUE_TEMPLATE/* - .github/PULL_REQUEST_TEMPLATE/* + .github/pull_request_template.md toolchains.xml settings.xml