Skip to content

Commit 5540abb

Browse files
authored
docs: add pr template
1 parent 26956a8 commit 5540abb

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

PULL_REQUEST_TEMPLATE.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
<!--- Describe your changes in detail -->
5+
6+
## Motivation and Context
7+
<!--- Why is this change required? What problem does it solve? -->
8+
<!--- If it fixes an open issue, please link to the issue here. -->
9+
10+
## Usage examples
11+
<!--- Provide examples of intended usage -->
12+
13+
```js
14+
// commitlint.config.js
15+
module.exports = {
16+
17+
};
18+
```
19+
20+
```sh
21+
echo "your commit message here" | commitlint # fails/passes
22+
```
23+
24+
## How Has This Been Tested?
25+
<!--- Please describe in detail how you tested your changes. -->
26+
27+
## Types of changes
28+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
29+
- [ ] Bug fix (non-breaking change which fixes an issue)
30+
- [ ] New feature (non-breaking change which adds functionality)
31+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
32+
33+
## Checklist:
34+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
35+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
36+
- [ ] My change requires a change to the documentation.
37+
- [ ] I have updated the documentation accordingly.
38+
- [ ] I have added tests to cover my changes.
39+
- [ ] All new and existing tests passed.

0 commit comments

Comments
 (0)