From 53a8b752c5c692d70df36d447175f67c4aab28d0 Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Wed, 18 Dec 2024 09:28:14 +0100 Subject: github: Add issue/PR templates MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Miquel Sabaté Solà --- .github/ISSUE_TEMPLATE/custom.md | 15 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 14 ++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/custom.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md new file mode 100644 index 0000000..beb958e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom.md @@ -0,0 +1,15 @@ +--- +name: Custom issue template +about: General issues, both bugs and features. +title: '' +labels: '' +assignees: mssola +--- + +### Description + +- **Expected behavior**: I expected this to happen! +- **Actual behavior**: But this happened... +- **Provide the versions** of: + - Git sha. + - Toolchain version: (rustc, cargo, et al) 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! -- cgit v1.2.3