From 4e7730ea4306f5725435aaa3308797880d902563 Mon Sep 17 00:00:00 2001 From: HappyNTH Date: Fri, 25 Oct 2024 16:41:20 +0100 Subject: [PATCH] Create templates akin to web versions --- .github/ISSUE_TEMPLATE/bug_report.md | 19 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 25 +++++++++++++++++++++++ .github/pull_request_template.md | 19 +++++++++++++++++ 3 files changed, 63 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.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..d9a1fd536 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,19 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' +--- + +**Description** +A clear and concise description of what the bug is. + +**Reproduction** +A description of the issue area, or steps/queries/mutations to reproduce the behavior. + +**Expected Behavior** +A clear and concise description of what you expected to happen. + +**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 000000000..2129a81cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,25 @@ +--- +name: Feature request +about: Suggest an enhancement for this project +title: '' +labels: enhancement +assignees: '' +--- + +**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, and why you've discounted them. + +**Additional Context** +Add any other context or screenshots about the feature request here. + +**Implementation Steps** +If you feel confident, provide implementation steps: + +- [ ] Update API call 'x' +- [ ] Add to component 'y' diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..0dd4bcc29 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,19 @@ +**PR Steps** + +These steps are to ensure you correctly make a PR. _Please delete them before submitting the PR!_ + +1. For almost all development, you should be targeting `dev` rather than `main`. Only releases target `main`! +2. Give your PR a descriptive name, and prefix that name with one of the following options: + - `fix:` for bug fixes + - `feat:` for new features + - `repo:` for repository fixes + - `deps:` for dependency updates + - If your PR does more than one of the above, focus on the primary purpose of your PR. E.g. if you have fixed small bugs in the process of implementing a feature, use `feat:` +3. Tag your PR! It makes it easier to know what's going on at a glance +4. Assign yourself to make clear you're working on it + +**Description** + +A clear and concise description of what changes this PR makes. + +Resolves/Fixes #(issue)