From df2475d7c9f6579ea7cd10a16bc9b5d89c91c141 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Pinard?= Date: Fri, 27 Sep 2024 12:38:46 +0200 Subject: [PATCH] Create pull_request_template.md --- .github/pull_request_template.md | 15 +++++++++++++++ 1 file changed, 15 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..c2252e0 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ +# Pull Request + +## Describe your changes + +## Issue number if applicable + +## Checklist before requesting a review + +Github actions will check that these tasks were performed but it will reduce friction if you deal with them beforhand + +- [ ] If code is added, the new lines are covered by tests (Checked by [Codecov](https://app.codecov.io/gh/XXII-AI/Lours)) +- [ ] Type hints are consistent (Checked by [pyright](https://github.com/XXII-AI/Lours/blob/main/.github/workflows/CI.yaml#L95) Job) +- [ ] Code style follows black conventions (Checked by [pre-commit](https://results.pre-commit.ci/repo/github/816858832)) +- [ ] If documentation is added, it does not raise a warning in sphinx (checked by [sphinx-build](https://github.com/XXII-AI/Lours/blob/main/.github/workflows/CI.yaml#L65)) +- [ ] CHANGELOG has been updated if applicable