Skip to content

Commit

Permalink
GitHub: update issue templates for easier use.
Browse files Browse the repository at this point in the history
  • Loading branch information
greenrobot-team committed Oct 24, 2023
1 parent 1e664bb commit 2965b9b
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 42 deletions.
96 changes: 63 additions & 33 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,96 @@
---
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: ''

---

<!--
BEFORE you submit this issue, please check:
- existing issues: https://github.com/objectbox/objectbox-dart/issues
- the FAQ page: https://docs.objectbox.io/faq
- the Troubleshooting page: https://docs.objectbox.io/troubleshooting
-->
_TODO Description (clear and concise, in English)_
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
_TODO Provide the following information as needed_
-->

### Basic info:
### Is there an existing issue?

- ObjectBox version: [e.g. 0.14.0]
- Flutter/Dart SDK: [e.g. 2.0.0, or the output of `dart --version` or `flutter --version`]
- Reproducible: [e.g. occurred once only | occasionally without pattern | always]
- Build OS: [e.g. Ubuntu 22.04 | Windows 11 | macOs 10.14 ]
- Deployment device or OS: [e.g. Galaxy S20 | Android 13 | iOS 16.4 ]
- [ ] I have searched [existing issues](https://github.com/objectbox/objectbox-dart/issues)

Additionally, you can choose to provide more details, e.g. the output of:
### Build info

* `pub deps --no-dev`
* `flutter doctor -v`
- objectbox version: [e.g. 2.3.1]
- Flutter/Dart version: [e.g. 3.1.0, see `flutter --version` or `dart --version`]
- Build OS: [e.g. Ubuntu 22.04 | Windows 11 | macOS 10.16 ]
- Deployment OS or device: [e.g. Android 14 | iOS 16.4 | Galaxy S23 ]

### Steps to reproduce

_TODO_
_TODO Tell us exactly how to reproduce the problem._

1. Put '...'
2. Make changes to '....'
3. See error
1. ...
2. ...
3. ...

### Expected behavior

_TODO A clear and concise description of what you expected to happen._
_TODO Tell us what you expect to happen._

### Actual behavior

_TODO Tell us what actually happens._

### Code

_TODO If applicable, add code to help explain your problem._
_TODO Add a code example to help us reproduce your problem._

- Include your pubspec.yaml.
- Include affected entity classes.
- Please remove any unnecessary or confidential parts.
- At best, link to or attach a project with a failing test.
<!--
You can create a minimal package with e.g. `flutter create bug`.
Things you maybe should also include:
- the entity class
- the pubspec.yaml
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.
-->

<details><summary>Code</summary>

```dart
[Paste your code here]
```

</details>

### Logs, stack traces

_TODO If applicable, add relevant logs, or a stack trace._
_TODO Add relevant logs, a stack trace or crash report._

<!--
- Logs for the currently connected device are accessed using `flutter logs`.
- ObjectBox logs are tagged with e.g. Box.
- If an iOS device crashes, [attach the device crash log](https://help.apple.com/xcode/mac/current/#/dev0f3181c2c).
- If an iOS simulator crashes, attach the crash log from `~/Library/Logs/DiagnosticReports`.
### Additional context
Additionally, you can choose to provide more details, e.g. the output of:
* `pub deps --no-dev`
* `flutter doctor -v`
-->

_TODO Add any other context about the problem here._
<details><summary>Logs</summary>

- Is there anything special about your app?
- May transactions or multi-threading play a role?
- Did you find any workarounds to prevent the issue?
```console
[Paste your logs here]
```

</details>
26 changes: 17 additions & 9 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,36 @@
---
name: Feature request
about: Suggest an idea
about: Suggest an improvement for ObjectBox.
title: ''
labels: 'enhancement'
assignees: ''

---

<!--
BEFORE you submit this issue, please check:
- existing issues: https://github.com/objectbox/objectbox-dart/issues
- the FAQ page: https://docs.objectbox.io/faq
- the Troubleshooting page: https://docs.objectbox.io/troubleshooting
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
-->

_TODO Clear and concise description of what problem you are trying to solve._
### Is there an existing issue?

- [ ] I have searched [existing issues](https://github.com/objectbox/objectbox-dart/issues)

### Use case

_TODO Describe what problem you are trying to solve._

### Describe the solution you'd like
### Proposed solution

_TODO A clear and concise description of what you want to happen._
_TODO Describe what you want to be able to do with ObjectBox._

### Describe alternatives you've considered

_TODO A clear and concise description of any alternative solutions or features you've considered._
_TODO Describe any alternative solutions or features you've considered._

### Additional context

Expand Down

0 comments on commit 2965b9b

Please sign in to comment.