Skip to content

Commit 0e42e1c

Browse files
authored
add PR templates (ecmwf#161)
* add pr templates * add pr templates
1 parent 8b4801f commit 0e42e1c

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

.github/pull_request_template.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## Description
2+
3+
<!-- Provide a brief summary of the changes introduced in this pull request. -->
4+
5+
## Type of Change
6+
7+
- [ ] Bug fix (non-breaking change which fixes an issue)
8+
- [ ] New feature (non-breaking change which adds functionality)
9+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] Documentation update
11+
12+
## Issue Number
13+
14+
<!-- Link the Issue number this change addresses, ideally in one of the "magic format" such as Closes #XYZ -->
15+
16+
<!-- Alternatively, explain the motivation behind the changes and the context in which they are being made. -->
17+
18+
## Code Compatibility
19+
20+
- [ ] I have performed a self-review of my code
21+
22+
### Code Performance and Testing
23+
24+
- [ ] If the new feature introduces modifications at the config level, I have made sure to have notified the other software developers throuth Mattermost and updated the paths in the `$WEATHER_GENERATOR_PRIVATE` directory
25+
26+
<!-- In case this affects the model sharding or other specific components please describe these here. -->
27+
28+
### Dependencies
29+
30+
- [ ] I have ensured that the code is still pip-installable after the changes and runs
31+
- [ ] I have tested that new dependencies themselves are pip-installable.
32+
- [ ] I have not introduced new dependencies in the inference portion of the pipeline
33+
34+
<!-- List any new dependencies that are required for this change and the justification to add them. -->
35+
36+
### Documentation
37+
38+
- [ ] My code follows the style guidelines of this project
39+
- [ ] I have updated the documentation and docstrings to reflect the changes
40+
- [ ] I have added comments to my code, particularly in hard-to-understand areas
41+
42+
<!-- Describe any major updates to the documentation -->
43+
44+
## Additional Notes
45+
46+
<!-- Include any additional information, caveats, or considerations that the reviewer should be aware of. -->

0 commit comments

Comments
 (0)