From f6358204bf4e40491bdab64331599885ade9658f Mon Sep 17 00:00:00 2001 From: tchapacan Date: Fri, 29 Mar 2024 23:02:11 +0100 Subject: [PATCH] add templates --- .github/ISSUE_TEMPLATE/bug-template.md | 55 +++++++++++++++++++ .../pull_request_template.md | 26 +++++++++ 2 files changed, 81 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-template.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug-template.md b/.github/ISSUE_TEMPLATE/bug-template.md new file mode 100644 index 0000000..5ed921c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-template.md @@ -0,0 +1,55 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: ['bug'] +assignees: + +--- + +## Outline of the bug + + + +### Logs + + + +### How to encounter/reproduce bug + + + +### Expected behavior + + + +### Screenshots + + + +### Additional context + + + +### Versions (please complete the following information): +- hardware: [e.g. raspberry pi] +- OS: [e.g. macos] +- cargo: [e.g. 1.77.1] +- rustc: [e.g. 1.77.1] +- docker: [e.g. 24.0.7] +- livebox: [e.g. 6] +- etc if necessary... \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..8c44681 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,26 @@ +# Description + + + +Fix: + +## Type of change + +- [ ] 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) +- [ ] Documentation update +- [ ] Test update +- [ ] Dependencies update + +# Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes