Skip to content

Commit 4bc1127

Browse files
bors[bot]Bromeon
andauthored
Merge #807
807: Provide 4 issue templates r=Bromeon a=Bromeon Adds issue templates for: * Feature requests * Quality-of-life improvements * Bug reports * Questions Helps guide users to structure their requests, through HTML comments at the top. The templates deliberately don't enforce any structure, to avoid needless bureaucracy. Co-authored-by: Jan Haller <bromeon@gmail.com>
2 parents c24925a + 8b0e643 commit 4bc1127

File tree

4 files changed

+71
-0
lines changed

4 files changed

+71
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Bug report
3+
about: 'Behavior which is broken or not conforming to documentation'
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Bug reports document cases where the library does not behave as intended or documented.
12+
If you are unsure about how to use the library, open a 'Question' issue or ask on Discord: https://discord.gg/FNudpBD
13+
For missing functionality, open a 'Feature request' instead.
14+
For functionality that works but is not very accessible, open a 'Quality of life' issue instead.
15+
16+
In your bug report, please mention how to reproduce the problem and if possible, provide short example code.
17+
In case you're not working on latest master, specify which godot-rust version you use.
18+
-->
19+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: 'Suggest new functionality to be added'
4+
title: ''
5+
labels: feature
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Feature requests add new functionality to the library.
12+
For ergonomic or internal improvements, open a 'Quality of life' issue instead.
13+
14+
In your request, please mention the motivation for the new feature,
15+
as well as potential drawbacks and alternatives.
16+
-->
17+
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Quality of life
3+
about: 'Improve existing parts: API design, documentation, refactoring'
4+
title: ''
5+
labels: quality-of-life
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Quality-of-life issues improve existing aspects of the library: API ergonomics, documentation, refactoring.
12+
For new functionality, open a 'Feature request' instead.
13+
For functionality which is broken rather than provided in a suboptimal way, open a 'Bug report'.
14+
15+
In your request, please mention the motivation for the change,
16+
as well as potential drawbacks and alternatives.
17+
-->
18+

.github/ISSUE_TEMPLATE/question.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Question
3+
about: 'Ask a question about the library. Or, join our Discord: https://discord.gg/FNudpBD'
4+
title: ''
5+
labels: question
6+
assignees: jacobsky
7+
8+
---
9+
10+
<!--
11+
Question issues are for questions about how to use the library, but also design and API related questions.
12+
Make sure you have read the relevant parts of the book, especially the FAQ: https://godot-rust.github.io/book/faq.html
13+
14+
Instead of an issue, also consider joining our Discord server for more interactive discussion!
15+
You can follow this invite link: https://discord.gg/FNudpBD
16+
-->
17+

0 commit comments

Comments
 (0)