Skip to content

Commit 6a8ca5e

Browse files
GitHub: update issue template for easier editing.
Also provide hints on how to collect some logs and crash reports.
1 parent 3423d04 commit 6a8ca5e

File tree

2 files changed

+104
-40
lines changed

2 files changed

+104
-40
lines changed
Lines changed: 81 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,99 @@
11
---
22
name: Bug report
3-
about: Something is broken in ObjectBox? Help us to fix it.
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://swift.objectbox.io/
13-
- FAQ page https://swift.objectbox.io/faq
10+
<!--
1411
15-
**Describe the bug**
16-
A clear and concise description in English of what the bug is.
12+
If you are looking for support, please check out our documentation:
13+
- https://swift.objectbox.io/
14+
- https://swift.objectbox.io/faq
1715
18-
**Basic info (please complete the following information):**
19-
- ObjectBox version (are you using the latest version?): [e.g. 1.3.1]
20-
- Reproducibility: [e.g. occurred once only | occasionally without visible pattern | always]
21-
- Device: [e.g. iPhone 11]
22-
- OS: [e.g. iOS 13]
16+
-->
2317

24-
**To Reproduce**
25-
Steps to reproduce the behavior:
26-
1. Put '...'
27-
2. Make changes to '....'
28-
3. See error
18+
### Is there an existing issue?
2919

30-
**Expected behavior**
31-
A clear and concise description of what you expected to happen.
20+
- [ ] I have searched [existing issues](https://github.com/objectbox/objectbox-swift/issues)
21+
22+
### Build info
23+
24+
- ObjectBox version: [e.g. 1.9.0]
25+
- OS: [e.g. iOS 17 | macOS 10.14 ]
26+
- Device/chipset: [e.g. iPhone 15 | Apple M2 ]
27+
28+
### Steps to reproduce
29+
30+
_TODO Tell us exactly how to reproduce the problem._
31+
32+
1. ...
33+
2. ...
34+
3. ...
35+
36+
### Expected behavior
37+
38+
_TODO Tell us what you expect to happen._
39+
40+
### Actual behavior
41+
42+
_TODO Tell us what actually happens._
43+
44+
### Code
45+
46+
_TODO Add a code example to help us reproduce your problem._
3247

33-
**Code**
34-
If applicable, add code to help explain your problem.
3548
- Include affected entity classes.
3649
- Please remove any unnecessary or confidential parts.
3750
- At best, link to or attach a project with a failing test.
3851

39-
**Logs, stack traces**
40-
If applicable, add relevant logs, or a stack trace.
52+
<!--
53+
54+
Please provide a minimal code example.
55+
56+
Things you maybe should also include:
57+
- the entity class
58+
- the Podfile
59+
60+
You can also create a public GitHub repository and link to it below.
61+
62+
Please do not upload screenshots of text, use code blocks like below instead.
63+
64+
Add any other context about the problem:
65+
- Is there anything special about your app?
66+
- May transactions or multi-threading play a role?
67+
- Did you find any workarounds to prevent the issue?
68+
69+
-->
70+
71+
<details><summary>Code</summary>
72+
73+
```swift
74+
[Paste your code here]
75+
```
76+
77+
</details>
78+
79+
### Logs, stack traces
80+
81+
_TODO Add relevant logs, a stack trace or crash report._
82+
83+
<!--
84+
85+
- For Swift exceptions include the full stack trace.
86+
- If an iOS device crashes, attach the device crash log: https://help.apple.com/xcode/mac/current/#/dev0f3181c2c
87+
- If an iOS simulator crashes, attach the crash log from `~/Library/Logs/DiagnosticReports`.
88+
- If a macOS device crashes, attach the crash report from Console: https://support.apple.com/guide/console/reports-cnsl664be99a/mac
89+
- Also check logs before the error. ObjectBox logs are tagged with e.g. Box.
90+
91+
-->
92+
93+
<details><summary>Logs</summary>
94+
95+
```console
96+
[Paste your logs here]
97+
```
4198

42-
**Additional context**
43-
Add any other context about the problem here.
44-
- Is there anything special about your code?
45-
- May transactions or multi-threading play a role?
46-
- Did you find any workarounds to prevent the issue?
99+
</details>

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,30 @@ assignees: ''
77

88
---
99

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

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

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

0 commit comments

Comments
 (0)