Skip to content

Commit

Permalink
Update issue templates (#73)
Browse files Browse the repository at this point in the history
* Add license badge

* Fix license badge

* Fix wrong project name in a text

* Add config.yml file

* Update behaviour bug template

* Add title to the templates

* Improve text in the bug template
  • Loading branch information
theEvilReaper authored Jan 3, 2024
1 parent 9c49588 commit fd001ec
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 26 deletions.
66 changes: 41 additions & 25 deletions .github/ISSUE_TEMPLATE/behavior-bug.yml
Original file line number Diff line number Diff line change
@@ -1,42 +1,58 @@
name: Behavior Bug
description: Report issues with plugin incompatibility or other behavior related issues.
description: Report issues with invalid code generation or other behavior bugs
title: "[Bug]: "
labels: [ "status: needs triage", "type: bug" ]
body:
- type: textarea
- type: markdown
attributes:
value: |
Thank you for reporting a bug to DartPoet!
Please fill out the information below to help us understand the issue.
- type: markdown
attributes:
value: |
Before filling the form fields, please consider the following:
- Search for existing issues in the [issue tracker](https://github.com/theEvilReaper/DartPoet/issues)
- type: input
attributes:
label: Expected behavior
description: What you expected to see.
label: DartPoet version
description: Please enter the version of DartPoet you are using.
placeholder: 1.0.0
validations:
required: true

required: false
- type: textarea
attributes:
label: Actual behavior
description: What you actually saw.
label: Describe the bug
description: |
A clear and concise description of what the bug is.
If you have a screenshot of the bug, please attach it below.
validations:
required: true

- type: textarea
attributes:
label: Steps to reproduce
description: This may include a video, or detailed instructions to help reconstruct the issue.
label: Steps to reproduce the bug
description: Tell us exactly how to reproduce the bug you are experiencing
placeholder: |
1. ...
2. ...
3. ...
validations:
required: true

- type: textarea
attributes:
label: Other
label: Code sample
description: |
Please include other helpful information below.
The more information we receive, the quicker and more effective we can be at finding the solution to the issue.
validations:
required: false

- type: markdown
attributes:
Please create a reproducible sample to show us the bug in action and attach it below between the lines with the backticks.
This helps us to verify that the bug is valid and prevents us from having to ask you for a sample later.
Without this we will unlikely be able to progress on the issue, and because of that
we regretfully will have to close it.
**Note**: Please do not upload screenshots of text. Instead, use code blocks
or the above mentioned ways to upload your code sample.
value: |
Before submitting this issue, please ensure the following:
1. You searched for and ensured there isn't already an open issue regarding this.
2. Your version of kotlin/java is supported by DartPoet.
3. You are running the latest version of DartPoet from [our github page](https://github.com/theEvilReaper/DartPoet).
```kotlin
[Paste your code here]
```
validations:
required: true
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: false
contact_links:
- name: DartPoet discussions
url: https://github.com/theEvilReaper/DartPoet/discussions
about: If you have any questions or problems, please use the discussions section
emoji:
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
name: Feature Request
description: Suggest an idea for DartPoet
title: "[Feature Request]: "
labels: [ "status: needs triage", "type: feature" ]
body:
- type: markdown
attributes:
value: |
Thank you for filling out a feature request for SolarSystem! Please be as detailed as possible so that we may consider and review the request easier.
Thank you for filling out a feature request for DartPoet! Please be as detailed as possible so that we may consider and review the request easier.
We ask that you search all the issues to avoid a duplicate feature request. If one exists, please reply if you have anything to add.
Before requesting a new feature, please make sure you are using the latest version and that the feature you are requesting is not already in DartPoet.
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# DartPoet

[![license](https://img.shields.io/github/license/theEvilReaper/DartPoet?style=for-the-badge&color=b2234c)](../LICENSE)

# **DartPoet is still in development and not ready for production use.**

## Description
Expand Down

0 comments on commit fd001ec

Please sign in to comment.