Skip to content

Commit

Permalink
Create pull_request_template.md
Browse files Browse the repository at this point in the history
This addresses issue #99
  • Loading branch information
bbakernoaa authored Jan 4, 2024
1 parent 0487935 commit b7035be
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<!-- PLEASE READ -->
<!-- Any PRs not following this template will be closed -->
<!--
Please use a short (<60 char), descriptive title above. It should complete the sentence "If merged, this PR will _____". Capitalize the first word and do not end with a period.
PRs should meet these guidelines:
- Each PR should address ONE topic and have an associated issue.
- No hard-coded paths or personal directories.
- No temporary or backup files should be committed (including logs).
- Any code that you disabled by being commented out should be removed or reenabled.
Please delete all these comments before submitting the PR.
-->
# Description
<!-- This description will become the commit message for the PR-->
<!-- Please use this format for your description:
Describe your changes. Focus on the *what* and *why*. The *how* will be evident from the changes. In particular, be sure to note any interface changes, such as command line syntax, that will need to be communicated to users.
At the end of your description, please be sure to add the issue this PR solves using the word "Resolves". If there are any issues that are related but not yet resolved (including in other repos), you may use "Refs".
Resolves #1234
Refs #4321
Refs NOAA-EMC/repo#5678
-->

# Type of change
<!-- Delete all except one -->
- Bug fix (fixes something broken)
- New feature (adds functionality)
- Maintenance (code refactor, clean-up, new CI test, etc.)

# Change characteristics
- Is this a breaking change (a change in existing functionality)? YES/NO
- Does this change require a documentation update? YES/NO

# How has this been tested?
<!-- Please list any test you conducted, including the machine.
Example:
- Clone and build on WCOSS
- Cycled test on Orion
- Forecast-only on Hera
-->

# Checklist
- [ ] Any dependent changes have been merged and published
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] My changes generate no new warnings
- [ ] New and existing tests pass with my changes
- [ ] I have made corresponding changes to the documentation if necessary

0 comments on commit b7035be

Please sign in to comment.