Skip to content

Commit 350f317

Browse files
authored
enhance: Issue templates (#226)
Added `config.yml` for issue templates, aswell as an enhanced bug report form
1 parent d74ae97 commit 350f317

File tree

3 files changed

+56
-32
lines changed

3 files changed

+56
-32
lines changed
+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: 🐛 Report a bug
2+
description: If you have found a bug on MyFinances report it here!
3+
title: "bug: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
9+
Hey there, thanks for creating a bug report, it's much appreciated!
10+
> Note: This is strictly for **bug** reports, issues setting up or feature requests should be discussed on the Discussions tab.
11+
12+
Before creating the bug report, please make sure that you have done the following steps:
13+
- [ ] Only post **one** problem *per* bug report
14+
- [ ] Updated to the latest [official release](https://github.com/TreyWW/MyFinances/releases)
15+
- [ ] Update your database with the latest migrations `py manage.py migrate`
16+
17+
- type: input
18+
id: version
19+
validations:
20+
required: true
21+
attributes:
22+
label: What version of MyFinances are you currently using?
23+
description: You can view by using the command `git describe --tags`
24+
placeholder: "v0.2.1"
25+
- type: dropdown
26+
id: device
27+
validations:
28+
required: false
29+
attributes:
30+
label: What device type are you currently facing the issue on?
31+
multiple: true
32+
options:
33+
- Mobile
34+
- Desktop
35+
- type: input
36+
id: description
37+
validations:
38+
required: true
39+
attributes:
40+
label: Describe the bug
41+
description: |
42+
Please describe the bug in detail, make sure to list HOW you get the bug to come up (steps exactly what you follow, including the page path)
43+
> To use code blocks, use ``` at the start and end of your code snippets. DO NOT USE SCREENSHOTS OF CODE.
44+
45+
You may paste links of any images, please use a trusted source like imgur, or upload directly using github

.github/ISSUE_TEMPLATE/bug-report.md

-32
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🔍 View Issues
4+
url: https://github.com/TreyWW/MyFinances/issues?q=is%3Aissue
5+
about: If you have found an issue (or a bug), try searching our issues tab before reporting it.
6+
- name: ❓ Need some help
7+
url: https://github.com/TreyWW/MyFinances/discussions/categories/q-a
8+
about: If you have a question or are stuck setting up the project, open a Q&A discussion!
9+
- name: 💡 Idea or Feature request
10+
url: https://github.com/TreyWW/MyFinances/discussions/new?category=ideas
11+
about: If you would like to suggest a new idea or would like a new feature added to MyFinances, discuss it on the Discussions tab!

0 commit comments

Comments
 (0)