From b24b214ef79fda954125f71d435580059ca04457 Mon Sep 17 00:00:00 2001 From: Marcus Date: Mon, 2 Oct 2023 02:48:56 -0700 Subject: [PATCH] propose a PR template to help newcomers get started more easily. --- .github/pull_request_template.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..04f30d28e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,27 @@ +# Description + +Please include a summary of the changes and the related issue. Please also include relevant motivation and context. + +Fixes # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +# How Has This Been Tested? + + Please also list any relevant details for your test configuration + +# Checklist: + +- [ ] I have run `bazel build @rules_rust//:rustfmt && ./rust_fmt.sh` to format my code +- [ ] Updated documentation if needed +- [ ] Tests added/amended +- [ ] `bazel test //...` passes locally +- [ ] PR is contained in a single commit, using `git amend` see some [docs](https://www.atlassian.com/git/tutorials/rewriting-history) +