Skip to content

Commit 5ff42fd

Browse files
warix8Marc-Andrieu
andauthored
Better PR template (#856)
### Description Change to the pull request template to improve reviews and enable quick understanding of the nature of the changes to be reviewed. --------- Co-authored-by: Marc-Andrieu <[email protected]>
1 parent 04944fd commit 5ff42fd

File tree

1 file changed

+51
-6
lines changed

1 file changed

+51
-6
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 51 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,54 @@
1-
### Description
1+
## Description
22

3-
Please explain the changes you made here.
3+
### Summary
44

5-
### Checklist
5+
<!--Brief description of what this PR does.-->
66

7-
- [ ] Created tests which fail without the change (if possible)
8-
- [ ] All tests passing
9-
- [ ] Extended the documentation, if necessary
7+
### Related Issues
8+
9+
<!-- If applicable -->
10+
Closes #<!--0-->
11+
12+
## Changes Made
13+
14+
<!--Please describe the changes made in this pull request-->
15+
16+
- ...
17+
18+
## Type of Change
19+
20+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
21+
- [ ] ✨ New feature (non-breaking change which adds functionality)
22+
- [ ] 🔨 Refactor (non-breaking change that neither fixes a bug nor adds a feature)
23+
- [ ] 🔧 Infra CI/CD (changes to configs of workflows)
24+
- [ ] 💥 BREAKING CHANGE (fix or feature that require a new minimal version of the front-end)
25+
26+
## Impact & Scope
27+
28+
- [ ] Core functionality changes
29+
- [ ] Single module changes
30+
- [ ] Multiple modules changes
31+
- [ ] Database migrations required
32+
- [ ] Other
33+
34+
## Testing
35+
36+
- [ ] Added/modified tests that pass the CI
37+
- [ ] Tested in a pre-prod
38+
- [ ] Tested this locally
39+
40+
## Documentation
41+
42+
- [ ] Updated docs accordingly (docs.myecl.fr) : <!--[Docs#0 - Title](https://github.com/aeecleclair/myecl-documentation/pull/0)-->
43+
- [ ] Code includes docstrings
44+
- [ ] No documentation needed
45+
46+
## Checklist
47+
48+
- [ ] My code follows the style guidelines of this project
49+
- [ ] I have commented my code, particularly in hard-to-understand areas
50+
- [ ] Any dependent changes have been merged and published (_Indicate the linked PR for the dependent changes_)
51+
52+
## Additional Notes
53+
54+
Add any other context, screenshots, or information about the pull request here.

0 commit comments

Comments
 (0)