Skip to content

Commit 6a6cde0

Browse files
authored
Add a pull request template (#82)
1 parent 2bc6040 commit 6a6cde0

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

.github/pull_request_template.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
Thank you for submitting a Pull Request. Please:
3+
* Read our commit style guide:
4+
Commit messages should adhere to the following points:
5+
* Separate subject from body with a blank line
6+
* Limit the subject line to 50 characters as much as possible
7+
* Capitalize the subject line
8+
* Do not end the subject line with a period
9+
* Use the imperative mood in the subject line
10+
* The verb should represent what was accomplished (Create, Add, Fix etc)
11+
* Wrap the body at 72 characters
12+
* Use the body to explain the what and why vs. the how
13+
For an example, look at the following link:
14+
https://docs.dissect.tools/en/latest/contributing/style-guide.html#example-commit-message
15+
16+
* Include a description of the proposed changes and how to test them.
17+
18+
* After creation, associate the PR with an issue, under the development section.
19+
Or use closing keywords in the body during creation:
20+
E.G:
21+
* close(|s|d) #<nr>
22+
* fix(|es|ed) #<nr>
23+
* resolve(|s|d) #<nr>
24+
-->

0 commit comments

Comments
 (0)