-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11 from natsuk4ze/Add-templates-for-issue-and-PR
Add templates for issue and pr
- Loading branch information
Showing
3 changed files
with
121 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,76 @@ | ||
name: Report a bug | ||
description: Create a report to help us improve. | ||
assignees: natsuk4ze | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Did you check the documentation and it did not help? | ||
options: | ||
- label: I have read the [README](https://github.com/natsuk4ze/compassx/blob/main/README.md) | ||
required: true | ||
- label: I have searched the [existing documentation](https://github.com/natsuk4ze/compassx/wiki) | ||
required: true | ||
- label: I have read the [contribution guide](https://github.com/natsuk4ze/compassx/blob/main/CONTRIBUTING.md) | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Overview | ||
description: Please clarify what kind of bug it is. | ||
placeholder: Description of the bug and paste the file where the error occurred here if necessary. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Steps to reproduce | ||
description: | | ||
Please tell us exactly how to reproduce the problem you are running into | ||
placeholder: | | ||
Steps to reproduce: | ||
1. ... | ||
2. ... | ||
3. ... | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Code sample | ||
description: Please create a minimal reproducible sample | ||
value: | | ||
<details><summary>Code sample</summary> | ||
```dart | ||
[Paste your code here] | ||
``` | ||
</details> | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Environment | ||
description: Please show us your `flutter doctor -v` result. | ||
value: | | ||
<details><summary>Logs</summary> | ||
```console | ||
[Paste flutter doctor logs here] | ||
``` | ||
</details> | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Logs | ||
description: Please show the error log. | ||
value: | | ||
<details><summary>Logs</summary> | ||
```console | ||
[Paste your logs here] | ||
``` | ||
</details> | ||
validations: | ||
required: false |
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 |
---|---|---|
@@ -0,0 +1,36 @@ | ||
name: Feature request | ||
description: Suggest a new idea. | ||
assignees: natsuk4ze | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Did you check the documentation and it did not help? | ||
options: | ||
- label: I have carefully read the [README](https://github.com/natsuk4ze/compassx/blob/main/README.md) | ||
required: true | ||
- label: I have carefully searched the [existing documentation](https://github.com/natsuk4ze/compassx/wiki) | ||
required: true | ||
- label: I have carefully read the [contribution guide](https://github.com/natsuk4ze/compassx/blob/main/CONTRIBUTING.md) | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Proposal | ||
description: | | ||
Briefly but precisely describe what you would like compassx to be able to do. | ||
Consider attaching code samples showing what you are imagining. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Use case | ||
description: | | ||
Please tell us the problem you are running into that led to you wanting | ||
a new feature. | ||
Is your feature request related to a problem? Please give a clear and | ||
concise description of what the problem is. | ||
Describe the alternative solutions you've considered. Is there a other | ||
package that already solves this? | ||
validations: | ||
required: true |
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 |
---|---|---|
@@ -0,0 +1,9 @@ | ||
## Overview | ||
|
||
_Please change this text to a brief statement of purpose or overview._ | ||
|
||
- [ ] I read the [Contribution Guide](https://github.com/natsuk4ze/compassx/blob/main/CONTRIBUTING.md). | ||
|
||
## Related Issues | ||
|
||
- |