aboutsummaryrefslogtreecommitdiff
path: root/.github/PULL_REQUEST_TEMPLATE.md
diff options
context:
space:
mode:
authorMiquel Sabaté Solà <mikisabate@gmail.com>2024-12-18 09:28:14 +0100
committerMiquel Sabaté Solà <mikisabate@gmail.com>2024-12-18 09:28:14 +0100
commit53a8b752c5c692d70df36d447175f67c4aab28d0 (patch)
tree8bbecaa0d2a24b1d8b72277f0954024736dae806 /.github/PULL_REQUEST_TEMPLATE.md
parent49bd7e8e49655da83d64969a54c6281bd6c6d2fe (diff)
downloadtools.nes-53a8b752c5c692d70df36d447175f67c4aab28d0.tar.gz
tools.nes-53a8b752c5c692d70df36d447175f67c4aab28d0.zip
github: Add issue/PR templates
Signed-off-by: Miquel Sabaté Solà <mikisabate@gmail.com>
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..c959def
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,14 @@
+Provide a general description of the changes in your pull request. If this pull
+request fixes a known issue, please tag it as well (e.g.: `Fixes #1`). In any
+case:
+
+- [ ] Write a [good commit message](https://chris.beams.io/posts/git-commit/).
+ Extra points if it's in the style of the [Linux
+ kernel](https://docs.kernel.org/process/submitting-patches.html).
+- [ ] Make sure that `cargo build` and `cargo test` continues to work.
+- [ ] Make sure that `cargo clippy --all-targets --all-features` does not report
+ any issues.
+- [ ] The pull request has *only* one subject and a clear title. You are not
+ submitting a pull request with tons of different unrelated commits.
+
+Thanks!