Skip to content

Commit 4a36ccb

Browse files
Merge branch 'main' into dev
2 parents 1ba0985 + 34ee9ce commit 4a36ccb

File tree

2 files changed

+116
-56
lines changed

2 files changed

+116
-56
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 90 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,98 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: You found a bug in ObjectBox causing an application to crash or throw an exception, or something does not work right.
44
title: ''
55
labels: 'bug'
66
assignees: ''
77

88
---
99

10-
:rotating_light: First, please check:
11-
- existing issues,
12-
- Docs https://docs.objectbox.io/
13-
- Troubleshooting page https://docs.objectbox.io/troubleshooting
14-
- FAQ page https://docs.objectbox.io/faq
15-
16-
**Describe the bug**
17-
A clear and concise description in English of what the bug is.
18-
19-
**Basic info (please complete the following information):**
20-
- ObjectBox version (are you using the latest version?): [e.g. 2.7.0]
21-
- Reproducibility: [e.g. occurred once only | occasionally without visible pattern | always]
22-
- Device: [e.g. Galaxy S20]
23-
- OS: [e.g. Android 10]
24-
25-
**To Reproduce**
26-
Steps to reproduce the behavior:
27-
1. Put '...'
28-
2. Make changes to '....'
29-
3. See error
30-
31-
**Expected behavior**
32-
A clear and concise description of what you expected to happen.
33-
34-
**Code**
35-
If applicable, add code to help explain your problem.
36-
- Include affected entity classes.
37-
- Please remove any unnecessary or confidential parts.
38-
- At best, link to or attach a project with a failing test.
39-
40-
**Logs, stack traces**
41-
If applicable, add relevant logs, or a stack trace.
42-
- For __build issues__, use `--stacktrace` for the Gradle build (`./gradlew build --stacktrace`).
43-
- For __runtime errors__, check Android's Logcat (also check logs before the issue!).
44-
45-
**Additional context**
46-
Add any other context about the problem here.
47-
- Is there anything special about your app?
48-
- May transactions or multi-threading play a role?
49-
- Did you find any workarounds to prevent the issue?
10+
<!--
11+
12+
If you are looking for support, please check out our documentation:
13+
- https://docs.objectbox.io
14+
- https://docs.objectbox.io/faq
15+
- https://docs.objectbox.io/troubleshooting
16+
17+
-->
18+
19+
### Is there an existing issue?
20+
21+
- [ ] I have searched [existing issues](https://github.com/objectbox/objectbox-java/issues)
22+
23+
### Build info
24+
25+
- ObjectBox version: [e.g. 3.7.0]
26+
- OS: [e.g. Android 14 | Ubuntu 22.04 | Windows 11 ]
27+
- Device/ABI/architecture: [e.g. Galaxy S23 | arm64-v8a | x86-64 ]
28+
29+
### Steps to reproduce
30+
31+
_TODO Tell us exactly how to reproduce the problem._
32+
33+
1. ...
34+
2. ...
35+
3. ...
36+
37+
### Expected behavior
38+
39+
_TODO Tell us what you expect to happen._
40+
41+
### Actual behavior
42+
43+
_TODO Tell us what actually happens._
44+
45+
46+
### Code
47+
48+
_TODO Add a code example to help us reproduce your problem._
49+
50+
<!--
51+
52+
Please provide a minimal code example.
53+
54+
Things you maybe should also include:
55+
- the entity class
56+
- the Gradle build script
57+
58+
You can also create a public GitHub repository and link to it below.
59+
60+
Please do not upload screenshots of text, use code blocks like below instead.
61+
62+
Add any other context about the problem:
63+
- Is there anything special about your app?
64+
- May transactions or multi-threading play a role?
65+
- Did you find any workarounds to prevent the issue?
66+
67+
-->
68+
69+
<details><summary>Code</summary>
70+
71+
```java
72+
[Paste your code here]
73+
```
74+
75+
</details>
76+
77+
### Logs, stack traces
78+
79+
_TODO Add relevant logs, a stack trace or crash report._
80+
81+
<!--
82+
83+
- For build issues, use `--stacktrace` to run the failing Gradle task. E.g. ./gradlew build --stacktrace
84+
- For runtime errors, check log output (e.g. Logcat on Android).
85+
- For Java/Kotlin exceptions include the full stack trace.
86+
- For native crashes on Android, include Logcat output starting from the *** *** *** line. Note that crash reporting tools like Crashlytics may hide this line.
87+
- For native crashes on JVM, include the hs_err_pidXXXX.log file.
88+
- Also check logs before the error. ObjectBox logs are tagged with e.g. Box.
89+
90+
-->
91+
92+
<details><summary>Logs</summary>
93+
94+
```console
95+
[Paste your logs here]
96+
```
97+
98+
</details>
Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,37 @@
11
---
22
name: Feature request
3-
about: Suggest an idea
3+
about: Suggest an improvement for ObjectBox.
44
title: ''
5-
labels: 'feature'
5+
labels: 'enhancement'
66
assignees: ''
77

88
---
99

10-
:rotating_light: First, please check:
11-
- existing issues,
12-
- Docs https://docs.objectbox.io/
13-
- Troubleshooting page https://docs.objectbox.io/troubleshooting
14-
- FAQ page https://docs.objectbox.io/faq
10+
<!--
1511
16-
Start with a clear and concise description of what problem you are trying to solve.
17-
Often there is already a solution!
12+
If you are looking for support, please check out our documentation:
13+
- https://docs.objectbox.io
14+
- https://docs.objectbox.io/faq
15+
- https://docs.objectbox.io/troubleshooting
1816
19-
**Describe the solution you'd like**
20-
A clear and concise description of what you want to happen.
17+
-->
2118

22-
**Describe alternatives you've considered**
23-
A clear and concise description of any alternative solutions or features you've considered.
19+
### Is there an existing issue?
2420

25-
**Additional context**
26-
Add any other context (e.g. platform or language) about the feature request here.
21+
- [ ] I have searched [existing issues](https://github.com/objectbox/objectbox-java/issues)
22+
23+
### Use case
24+
25+
_TODO Describe what problem you are trying to solve._
26+
27+
### Proposed solution
28+
29+
_TODO Describe what you want to be able to do with ObjectBox._
30+
31+
### Alternatives
32+
33+
_TODO Describe any alternative solutions or features you've considered._
34+
35+
### Additional context
36+
37+
_TODO Add any other context (e.g. platform or language) about the feature request here._

0 commit comments

Comments
 (0)