60 lines
979 B
Markdown
60 lines
979 B
Markdown
|
# PR Template
|
||
|
|
|
||
|
|
## Purpose
|
||
|
|
|
||
|
|
<!-- Describe the intention of the changes being proposed. What problem does it solve or functionality does it add? -->
|
||
|
|
|
||
|
|
- ...
|
||
|
|
|
||
|
|
## Does this introduce a breaking change?
|
||
|
|
|
||
|
|
<!-- Mark one with an "x". -->
|
||
|
|
|
||
|
|
```text
|
||
|
|
[ ] Yes
|
||
|
|
[ ] No
|
||
|
|
```
|
||
|
|
|
||
|
|
## Pull Request Type
|
||
|
|
|
||
|
|
What kind of change does this Pull Request introduce?
|
||
|
|
|
||
|
|
<!-- Please check the one that applies to this PR using "x". -->
|
||
|
|
|
||
|
|
```text
|
||
|
|
[ ] Bugfix
|
||
|
|
[ ] Feature
|
||
|
|
[ ] Code style update (formatting, local variables)
|
||
|
|
[ ] Refactoring (no functional changes, no api changes)
|
||
|
|
[ ] Documentation content changes
|
||
|
|
[ ] Other... Please describe:
|
||
|
|
```
|
||
|
|
|
||
|
|
## How to Test
|
||
|
|
|
||
|
|
- Get the code
|
||
|
|
|
||
|
|
```text
|
||
|
|
git clone [repo-address]
|
||
|
|
cd [repo-name]
|
||
|
|
git checkout [branch-name]
|
||
|
|
npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
- Test the code
|
||
|
|
<!-- Add steps to run the tests suite and/or manually test -->
|
||
|
|
|
||
|
|
```text
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
## What to Check
|
||
|
|
|
||
|
|
Verify that the following are valid
|
||
|
|
|
||
|
|
- ...
|
||
|
|
|
||
|
|
## Other Information
|
||
|
|
|
||
|
|
<!-- Add any other helpful information that may be needed here. -->
|