From fe2a49f95db6e1e73b2b0275d88ac6695fd3a247 Mon Sep 17 00:00:00 2001 From: ha-enthus1ast <134805222+ha-enthus1ast@users.noreply.github.com> Date: Thu, 14 Dec 2023 13:02:49 +0100 Subject: [PATCH] Added pull request template (#14) This change introduces a basic pull request template --- .github/pull_request_template.md | 29 +++++++++++++++++++++++++++++ .pre-commit-config.yaml | 1 + 2 files changed, 30 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 0000000..0901c5b --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,29 @@ + + +# Description + + + +Please include a summary of the changes and which issue is fixed. Please also include relevant motivation and context. + +Fixes # (issue) + +# License Acceptance + +- [ ] This repository is Apache version 2.0 licensed and by making this PR, I am contributing my changes to the repository under the terms of the Apache 2 license. + +# 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 + +# Checklist + +- [ ] I have read through the contributing guidelines +- [ ] My code follows the style guidelines of this project +- [ ] I have made corresponding changes to the documentation +- [ ] New and existing unit tests pass locally with my changes diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 9625e10..0282f3a 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -38,6 +38,7 @@ repos: rev: v2.2.0 hooks: - id: doctoc + exclude: '.github/pull_request_template\.md$' - repo: https://github.com/python-poetry/poetry rev: "1.4.1"