Skip to content

Commit

Permalink
Update GitHub issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
utarwyn committed May 26, 2024
1 parent 9a28b81 commit 6c1cff8
Show file tree
Hide file tree
Showing 6 changed files with 91 additions and 69 deletions.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: 🐞 Bug Report
description: This form is to report unexpected behavior in ecoCode-javascript.
labels: [ "💉 bug: unconfirmed" ]
body:
- type: markdown
attributes:
value: |
Thank you for taking your precious time to file an issue! 🙏 We are sorry for the inconvenience this issue has caused you and want to resolve it as soon as possible.
Help us help you! We know that your time is precious and hate to ask for any more of it, but the first step in fixing this issue is to understand the issue. Taking some extra time to ensure that we are able to reproduce the issue will help us significantly in resolving the issue.
- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: What is the behavior that currently you experience?
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: What is the behavior that you expect to happen?
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: Please provide some instructions to reproduce the issue. Be as detailed as possible.
value: |
1.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Failure Logs
description: Please include any relevant log snippets or files here. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: input
id: plugin-version
attributes:
label: ecoCode-javascript Version
description: Please provide the version of ecoCode-javascript that you are using.
validations:
required: true
- type: input
id: sonarqube-version
attributes:
label: SonarQube Version
description: Please provide the version of SonarQube that you are using if this is applicable.
- type: textarea
id: additional
attributes:
label: Additional Information
description: Is there any additional information that you can provide?
- type: markdown
attributes:
value: |
> If we are not able to reproduce the issue, we will likely prioritize fixing other issues we can reproduce. Please do your best to fill out all of the sections above.
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Start a Discussion
about: "Start a discussion to share your experience with ecoCode-javascript"
url: https://github.com/green-code-initiative/ecoCode-javascript/discussions/new/choose
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: ✨ Feature Request
description: This form is to request a new feature in ecoCode-javascript.
labels: [ "🚀 enhancement" ]
body:
- type: textarea
id: solution
attributes:
label: Solution you'd like
description: Please write a clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: problem-related
attributes:
label: Is your feature request related to a problem?
description: Please write a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
- type: textarea
id: alternatives
attributes:
label: Alternatives you've considered
description: Please include a clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: additional
attributes:
label: Additional Information
description: Is there any additional information or screenshots that you want to provide?
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

0 comments on commit 6c1cff8

Please sign in to comment.