Skip to content

Commit 0ac92b3

Browse files
authored
added pr template (#30)
* Create pull_request_template.md added pr template * Update pom.xml excluded the template in pom.xml
1 parent 8d70c2e commit 0ac92b3

2 files changed

Lines changed: 66 additions & 0 deletions

File tree

.github/pull_request_template.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
## Description
2+
3+
<!-- Please include a summary of changes made in your pull request. -->
4+
5+
<!-- If you can't fill all check boxes in Checklists section, please explain why. -->
6+
7+
## Checklists
8+
9+
<!-- Fill check boxes before submitting the pull request. -->
10+
11+
### Testing
12+
13+
#### General
14+
15+
- [ ] I have checked that my test files and functions have meaningful names.
16+
- [ ] I have checked that each test tests only a single behavior.
17+
- [ ] I have done happy tests.
18+
- [ ] I have tested only my own code.
19+
- [ ] I have tested at least all public methods.
20+
21+
#### Assertions
22+
23+
- [ ] I have checked that my tests use assertions and not runtime overhead.
24+
- [ ] I have checked that my tests end in assertions.
25+
- [ ] I have checked that there is no comparison statements in assertions.
26+
- [ ] I have checked that assertions are in tests and not in helper functions.
27+
- [ ] I have checked that assertions for iterables are outside of for loops and both sides of the iteration blocks.
28+
- [ ] I have checked that assertions are not tested inside consumers.
29+
30+
#### Testing Data
31+
32+
- [ ] I have tested algorithms and anything else with the possibility of unbound growth.
33+
- [ ] I have checked that all testing data is local and fully replaceable or reproducible or both.
34+
- [ ] I have checked that all test files are standalone.
35+
- [ ] I have checked that all test-specific fake objects and classes are in the test directory.
36+
- [ ] I have checked that my tests do not contain anything related to customers, infrastructure or users.
37+
- [ ] I have checked that my tests do not contain non-generic information.
38+
- [ ] I have checked that my tests do not do external requests and are not privately or publicly routable.
39+
40+
#### Statements
41+
42+
- [ ] I have checked that my tests do not use throws for exceptions.
43+
- [ ] I have checked that my tests do not use try-catch statements.
44+
- [ ] I have checked that my tests do not use if-else statements.
45+
46+
#### Java
47+
48+
- [ ] I have checked that my tests for Java uses JUnit library.
49+
- [ ] I have checked that my tests for Java uses JUnit utilities for parameters.
50+
51+
#### Other
52+
53+
- [ ] I have only tested public behavior and not private implementation details.
54+
- [ ] I have checked that my tests are not (partially) commented out.
55+
- [ ] I have checked that hand-crafted variables in assertions are used accordingly.
56+
- [ ] I have tested [Object Equality](https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html#equals%28java.lang.Object%29).
57+
- [ ] 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.
58+
59+
### Code Quality
60+
61+
- [ ] I have checked that my code follows metrics set in Procedure: Class Metrics.
62+
- [ ] I have checked that my code follows metrics set in Procedure: Method Metrics.
63+
- [ ] I have checked that my code follows metrics set in Procedure: Object Quality.
64+
- [ ] I have checked that my code does not have any NULL values.
65+
- [ ] I have checked my code does not contain FIXME or TODO comments.

pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,7 @@
345345
<exclude>.github/workflows/*.yml</exclude>
346346
<exclude>.github/workflows/*.yaml</exclude>
347347
<exclude>.github/ISSUE_TEMPLATE/*</exclude>
348+
<exclude>.github/pull_request_template.md</exclude>
348349
<exclude>toolchains.xml</exclude>
349350
<exclude>settings.xml</exclude>
350351
<exclude>rpm/rpm.pom.xml</exclude>

0 commit comments

Comments
 (0)