Skip to content

Commit 587e230

Browse files
committed
improved github issue template
1 parent 7de33b8 commit 587e230

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
*Please help us to fix issues asap: to reduce checking with you back and forth, use the template below. Replace italic sections with your input.
1+
*Before creating a new issue, make sure that you checked: (1) existing issues, (2) docs (3) FAQ.
2+
TEMPLATE FOR ISSUES ONLY - for feature requests just delete the text and start fresh.
3+
Please help us to fix issues asap: this template reduces checking with you back and forth.
4+
Replace italic sections with your input.
25
For __support questions__, please use [stackoverflow with the [objectbox] tag](https://stackoverflow.com/questions/tagged/objectbox) - we get notified.*
36

4-
## Basics
7+
## Issue Basics
58
- ObjectBox version (are using the latest version?): *?*
69
- Reproducibility: *[occurred once only | occasionally without visible pattern | always]*
710

@@ -10,13 +13,19 @@ For __support questions__, please use [stackoverflow with the [objectbox] tag](h
1013
*Describe the situation in English in which you encounter the bug.*
1114

1215
### Code
13-
*Provide the code triggering the bug. Ideally, try to keep it short by removing as much code as possible while preserving the issue. You get __extra karma points__ for sharing a runnable project on GitHub that reproduces the bug.*
16+
*Provide the code triggering the bug.
17+
Ideally, try to keep it short by removing as much code as possible while preserving the issue.
18+
You get __extra karma points__ for sharing a runnable project on GitHub that reproduces the bug.*
1419

1520
### Logs & stackstraces
16-
*Check if you have relevant logs and/or a stacktrace. For __build issues__, use `--stacktrace` for the Gradle build (`./gradlew build --stacktrace`). For __runtime errors__, check Android's Logcat (check also for relevant logs preceeding the issue itself).*
21+
*Check if you have relevant logs and/or a stacktrace.
22+
For __build issues__, use `--stacktrace` for the Gradle build (`./gradlew build --stacktrace`).
23+
For __runtime errors__, check Android's Logcat (check also for relevant logs preceeding the issue itself).*
1724

1825
## Entities
1926
*Provide the code for entities related to the bug (shorten to relevant parts).*
2027

2128
## Misc
22-
*Is there anything special about your app? May transactions or multi-threading play a role? Did you find any workarounds to prevent the issue?*
29+
*Is there anything special about your app?
30+
May transactions or multi-threading play a role?
31+
Did you find any workarounds to prevent the issue?*

0 commit comments

Comments
 (0)