Skip to content

Commit

Permalink
Add a pull request template
Browse files Browse the repository at this point in the history
  • Loading branch information
Miauwkeru committed Apr 11, 2024
1 parent 6850648 commit 1a4edec
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--
Thank you for submitting a Pull Request. Please:
* Read our commit style guide:
Commit messages should adhere to the following points:
* Separate subject from body with a blank line
* Limit the subject line to 50 characters as much as possible
* Capitalize the subject line
* Do not end the subject line with a period
* Use the imperative mood in the subject line
* The verb should represent what was accomplished (Create, Add, Fix etc)
* Wrap the body at 72 characters
* Use the body to explain the what and why vs. the how
For an example, look at the following link:
https://docs.dissect.tools/en/latest/contributing/style-guide.html#example-commit-message
* Include a description of the proposed changes and how to test them.
* After creation, associate the PR with an issue, under the development section.
Or use closing keywords in the body during creation:
E.G:
* close(|s|d) #<nr>
* fix(|es|ed) #<nr>
* resolve(|s|d) #<nr>
-->

0 comments on commit 1a4edec

Please sign in to comment.