-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Hubble 406 - Feature / PR template (#252)
* Create pull_request_template.md * final version * Update pull_request_template.md
- Loading branch information
Showing
1 changed file
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
<!-- If you're making a doc PR or something tiny where the below is irrelevant, delete this | ||
template and use a short description, but in your description aim to include both what the | ||
change is, and why it is being made, with enough context for anyone to understand. --> | ||
|
||
<details> | ||
<summary>PR Checklist</summary> | ||
|
||
### PR Structure | ||
|
||
* [ ] This PR has reasonably narrow scope (if not, break it down into smaller PRs). | ||
* [ ] This PR avoids mixing refactoring changes with feature changes (split into two PRs | ||
otherwise). | ||
* [ ] This PR's title starts with the jira ticket associated with the PR. | ||
|
||
### Thoroughness | ||
|
||
* [ ] This PR adds tests for the most critical parts of the new functionality or fixes. | ||
* [ ] I've updated the README with the added features, breaking changes, new instructions on how to use the repository. I updated the description of the fuction with the changes that were made. | ||
|
||
### Release planning | ||
|
||
* [ ] I've decided if this PR requires a new major/minor/patch version accordingly to | ||
[semver](https://semver.org/), and I've changed the name of the BRANCH to release/* , feature/* or patch/* . | ||
</details> | ||
|
||
### What | ||
|
||
[TODO: Short statement about what is changing.] | ||
|
||
### Why | ||
|
||
[TODO: Why this change is being made. Include any context required to understand the why.] | ||
|
||
### Known limitations | ||
|
||
[TODO or N/A] |