Skip to content

Commit 9a31dda

Browse files
author
Leah Wasser
authored
templates seem to work diff now
1 parent f825bd3 commit 9a31dda

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

.github/pull_request_template.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Earth Lab -- Pull Request Template
2+
Welcome to the earth analytics python environment repo!
3+
4+
Before submitting a Pull Request **please be sure to submit an issue that describes what the contents of the PR addresses**.
5+
6+
**IMPORTANT:** Please do not use this repository as a practice activity to learn how to use GitHub! Only submit a PR after:
7+
8+
1. Submitting an issue with a valid item that you wish to address in earthpy
9+
2. Getting approval from one of the maintainers to submit a formal PR.
10+
11+
## Description
12+
13+
Please include a summary of the change and which issue is fixed. Be sure to reference the ISSUE that this PR addresses which should have been approved by an earthpy maintainer.
14+
15+
Fixes # (issue)
16+
17+
## Type of change
18+
19+
Please delete options that are not relevant.
20+
21+
- [ ] Bug fix (non-breaking change which fixes an issue)
22+
- [ ] New feature (non-breaking change which adds functionality)
23+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
24+
- [ ] Documentation update
25+
26+
## How Has This Been Tested?
27+
28+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
29+
30+
- [ ] Test A
31+
- [ ] Test B
32+
33+
34+
## Checklist:
35+
36+
- [ ] I have already submitted an issue and i was invited to submit a pr by an earthdatascience.org maintainer
37+
- [ ] My code follows the style guidelines of this project
38+
- [ ] I have performed a self-review of my own code
39+
- [ ] I have commented my code, particularly in hard-to-understand areas
40+
- [ ] I have made corresponding changes to the documentation
41+
- [ ] My changes generate no new warnings
42+
- [ ] I have added tests that prove my fix is effective or that my feature works
43+
- [ ] New and existing unit tests pass locally with my changes
44+
- [ ] Any dependent changes have been merged and published in downstream modules
45+
- [ ] I have checked my code and corrected any misspellings

0 commit comments

Comments
 (0)