From 698c182a726027967cc8da5d8236073d4d0c1ff4 Mon Sep 17 00:00:00 2001 From: Trystan Schneider Date: Tue, 29 Oct 2024 11:30:16 +0100 Subject: [PATCH] docs: add pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 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..fc545e385 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,29 @@ +# Motivation + +[Include the reason behind these changes and any relevant context.] + +# Description + +[Provide a detailled explanation of the modifications you have made. Link any related issues.] + +# Testing + +[When applicable, detail the testing you have performed to ensure that these changes function as intended. Include information about any added tests.] + +# Impact + +[Discuss the impact of your modifications on ArmoniK. This might include effects on performance, configuration, documentation, new dependencies, or changes in behaviour.] + +# Additional Information + +[Any additional information that reviewers should be aware of.] + +# Checklist + +- [ ] My code adheres to the coding and style guidelines of the project. +- [ ] I have performed a self-review of my code. +- [ ] I have commented my code, particularly in hard-to-understand areas. +- [ ] I have made corresponding changes to the documentation. +- [ ] I have thoroughly tested my modifications and added tests when necessary. +- [ ] Tests pass locally and in the CI. +- [ ] I have assessed the performance impact of my modifications. \ No newline at end of file