Skip to content

Commit 9a38f45

Browse files
authored
Create pull_request_template.md
1 parent e852551 commit 9a38f45

1 file changed

Lines changed: 59 additions & 0 deletions

File tree

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Pull Request Template
2+
3+
## Description
4+
5+
Please include a summary of the change and which issue is fixed.
6+
7+
List any dependencies that are required for this change.
8+
9+
Fixes # (issue)
10+
11+
## Who did the changings?
12+
- [Your name](@your_github_tag)
13+
- [Another name](@github_tag)
14+
- ...
15+
16+
## Correlated issue
17+
Is this pull request correlated to an issue? If yes, please, complete the following test. In not, delate this section.
18+
19+
Fixed #...
20+
21+
## Type of change
22+
23+
Please delete options that are not relevant.
24+
25+
- [ ] Bug fix (non-breaking change which fixes an issue)
26+
- [ ] New feature (non-breaking change which adds functionality)
27+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
28+
- [ ] This change requires a documentation update
29+
30+
## How Has This Been Tested?
31+
32+
Please describe how you do the tests and how we can reproduce them.
33+
34+
**Test Configuration**:
35+
- Hardware:
36+
- OS:
37+
- Package method used:
38+
- Dependences:
39+
- Python:
40+
- ...
41+
- ...
42+
43+
### Instructions
44+
45+
- Setup: ...
46+
- Other(s) isnstructions: ...
47+
- End: ...
48+
49+
## Checklist:
50+
51+
- [ ] My code follows the style guidelines of this project
52+
- [ ] I have performed a self-review of my own code
53+
- [ ] I have commented my code, particularly in hard-to-understand areas
54+
- [ ] I have made corresponding changes to the documentation
55+
- [ ] My changes generate no new warnings
56+
- [ ] I have added tests that prove my fix is effective or that my feature works
57+
- [ ] New and existing unit tests pass locally with my changes
58+
- [ ] Any dependent changes have been merged and published in downstream modules
59+
- [ ] I have checked my code and corrected any misspellings

0 commit comments

Comments
 (0)