-
Notifications
You must be signed in to change notification settings - Fork 307
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GitHub: update issue templates for easier editing.
Also update to latest style.
- Loading branch information
1 parent
666f63b
commit 34ee9ce
Showing
2 changed files
with
116 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,98 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
about: You found a bug in ObjectBox causing an application to crash or throw an exception, or something does not work right. | ||
title: '' | ||
labels: 'bug' | ||
assignees: '' | ||
|
||
--- | ||
|
||
:rotating_light: First, please check: | ||
- existing issues, | ||
- Docs https://docs.objectbox.io/ | ||
- Troubleshooting page https://docs.objectbox.io/troubleshooting | ||
- FAQ page https://docs.objectbox.io/faq | ||
|
||
**Describe the bug** | ||
A clear and concise description in English of what the bug is. | ||
|
||
**Basic info (please complete the following information):** | ||
- ObjectBox version (are you using the latest version?): [e.g. 2.7.0] | ||
- Reproducibility: [e.g. occurred once only | occasionally without visible pattern | always] | ||
- Device: [e.g. Galaxy S20] | ||
- OS: [e.g. Android 10] | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Put '...' | ||
2. Make changes to '....' | ||
3. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Code** | ||
If applicable, add code to help explain your problem. | ||
- Include affected entity classes. | ||
- Please remove any unnecessary or confidential parts. | ||
- At best, link to or attach a project with a failing test. | ||
|
||
**Logs, stack traces** | ||
If applicable, add relevant logs, or a stack trace. | ||
- For __build issues__, use `--stacktrace` for the Gradle build (`./gradlew build --stacktrace`). | ||
- For __runtime errors__, check Android's Logcat (also check logs before the issue!). | ||
|
||
**Additional context** | ||
Add any other context about the problem here. | ||
- Is there anything special about your app? | ||
- May transactions or multi-threading play a role? | ||
- Did you find any workarounds to prevent the issue? | ||
<!-- | ||
If you are looking for support, please check out our documentation: | ||
- https://docs.objectbox.io | ||
- https://docs.objectbox.io/faq | ||
- https://docs.objectbox.io/troubleshooting | ||
--> | ||
|
||
### Is there an existing issue? | ||
|
||
- [ ] I have searched [existing issues](https://github.com/objectbox/objectbox-java/issues) | ||
|
||
### Build info | ||
|
||
- ObjectBox version: [e.g. 3.7.0] | ||
- OS: [e.g. Android 14 | Ubuntu 22.04 | Windows 11 ] | ||
- Device/ABI/architecture: [e.g. Galaxy S23 | arm64-v8a | x86-64 ] | ||
|
||
### Steps to reproduce | ||
|
||
_TODO Tell us exactly how to reproduce the problem._ | ||
|
||
1. ... | ||
2. ... | ||
3. ... | ||
|
||
### Expected behavior | ||
|
||
_TODO Tell us what you expect to happen._ | ||
|
||
### Actual behavior | ||
|
||
_TODO Tell us what actually happens._ | ||
|
||
|
||
### Code | ||
|
||
_TODO Add a code example to help us reproduce your problem._ | ||
|
||
<!-- | ||
Please provide a minimal code example. | ||
Things you maybe should also include: | ||
- the entity class | ||
- the Gradle build script | ||
You can also create a public GitHub repository and link to it below. | ||
Please do not upload screenshots of text, use code blocks like below instead. | ||
Add any other context about the problem: | ||
- Is there anything special about your app? | ||
- May transactions or multi-threading play a role? | ||
- Did you find any workarounds to prevent the issue? | ||
--> | ||
|
||
<details><summary>Code</summary> | ||
|
||
```java | ||
[Paste your code here] | ||
``` | ||
|
||
</details> | ||
|
||
### Logs, stack traces | ||
|
||
_TODO Add relevant logs, a stack trace or crash report._ | ||
|
||
<!-- | ||
- For build issues, use `--stacktrace` to run the failing Gradle task. E.g. ./gradlew build --stacktrace | ||
- For runtime errors, check log output (e.g. Logcat on Android). | ||
- For Java/Kotlin exceptions include the full stack trace. | ||
- For native crashes on Android, include Logcat output starting from the *** *** *** line. Note that crash reporting tools like Crashlytics may hide this line. | ||
- For native crashes on JVM, include the hs_err_pidXXXX.log file. | ||
- Also check logs before the error. ObjectBox logs are tagged with e.g. Box. | ||
--> | ||
|
||
<details><summary>Logs</summary> | ||
|
||
```console | ||
[Paste your logs here] | ||
``` | ||
|
||
</details> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,37 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea | ||
about: Suggest an improvement for ObjectBox. | ||
title: '' | ||
labels: 'feature' | ||
labels: 'enhancement' | ||
assignees: '' | ||
|
||
--- | ||
|
||
:rotating_light: First, please check: | ||
- existing issues, | ||
- Docs https://docs.objectbox.io/ | ||
- Troubleshooting page https://docs.objectbox.io/troubleshooting | ||
- FAQ page https://docs.objectbox.io/faq | ||
<!-- | ||
Start with a clear and concise description of what problem you are trying to solve. | ||
Often there is already a solution! | ||
If you are looking for support, please check out our documentation: | ||
- https://docs.objectbox.io | ||
- https://docs.objectbox.io/faq | ||
- https://docs.objectbox.io/troubleshooting | ||
**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. | ||
### Is there an existing issue? | ||
|
||
**Additional context** | ||
Add any other context (e.g. platform or language) about the feature request here. | ||
- [ ] I have searched [existing issues](https://github.com/objectbox/objectbox-java/issues) | ||
|
||
### Use case | ||
|
||
_TODO Describe what problem you are trying to solve._ | ||
|
||
### Proposed solution | ||
|
||
_TODO Describe what you want to be able to do with ObjectBox._ | ||
|
||
### Alternatives | ||
|
||
_TODO Describe any alternative solutions or features you've considered._ | ||
|
||
### Additional context | ||
|
||
_TODO Add any other context (e.g. platform or language) about the feature request here._ |