From a1125130bad8693dce49ea046323cfbe04081390 Mon Sep 17 00:00:00 2001 From: Janis Hutz Date: Sat, 31 Oct 2026 14:43:39 +0100 Subject: [PATCH] chore: add issue and pr templates --- .github/ISSUE_TEMPLATE/bug_report.md | 28 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 19 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE/features.md | 23 +++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/fixes.md | 14 ++++++++++++ .github/PULL_REQUEST_TEMPLATE/testing.md | 17 ++++++++++++++ 5 files changed, 101 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/features.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/fixes.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/testing.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..5d7768e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,28 @@ +--- +name: Bug report +about: Create an bug report +title: 'bug: ' +labels: 'bug' +assignees: 'janishutz' +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. GET request to '...' +2. POST request to '....' +2. GET request to '....' + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Run method** +How did you run the backend? Docker or Native? + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..629ab9c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest an addition or request a change +title: 'feat: ' +labels: 'enhancement' +assignees: 'janishutz' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE/features.md b/.github/PULL_REQUEST_TEMPLATE/features.md new file mode 100644 index 0000000..55cdf84 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/features.md @@ -0,0 +1,23 @@ +**Description** + + +**Breaking changes** +List all breaking changes here + + +**Refactored components** +List all refactored components here + + +**New dependencies** +List all explicit new deps and why they are needed + + +**AI usage declaration** +AI was used to +- [ ] create this PR descriptions on GitHub +- [ ] write some of the content of the PR +- [ ] all of the content of the PR +- [ ] to audit the content of the PR +- [ ] polish writing +- [ ] ... diff --git a/.github/PULL_REQUEST_TEMPLATE/fixes.md b/.github/PULL_REQUEST_TEMPLATE/fixes.md new file mode 100644 index 0000000..a618f93 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/fixes.md @@ -0,0 +1,14 @@ +**What issue does this fix address?** + + +**Any breaking changes or potential future issues to be aware of?** + + +**AI usage declaration** +AI was used to +- [ ] create this PR descriptions on GitHub +- [ ] write some of the content of the PR +- [ ] all of the content of the PR +- [ ] to audit the content of the PR +- [ ] polish writing +- [ ] ... diff --git a/.github/PULL_REQUEST_TEMPLATE/testing.md b/.github/PULL_REQUEST_TEMPLATE/testing.md new file mode 100644 index 0000000..dcdc46c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/testing.md @@ -0,0 +1,17 @@ +**Which routes are covered by the tests?** +Brief description +- /api/myroute + + +**New Requirements** +List any new requirements for running them here + + +**AI usage declaration** +AI was used to +- [ ] create this PR descriptions on GitHub +- [ ] write some of the content of the PR +- [ ] all of the content of the PR +- [ ] to audit the content of the PR +- [ ] polish writing +- [ ] ...