Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removing confusing redundant ISSUE_TEMPLATE folder under workflows and implementing the feature properly this time. Fixes #301 #304

Merged
merged 1 commit into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/bug.yaml

This file was deleted.

28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: 🐞 Bug
description: File a bug/issue
title: "[BUG] <describe issue in one line>"
labels: ["bug"]
body:
- type: textarea
id: description
attributes:
label: Description
description: Describe the issue.
placeholder: |
Please provide the following information here:
1. What's the issue?
1. Steps to reproduce it --> Use text for code/commands. Screenshots for output
1. Additional information --> Links to additional resources, etc.
validations:
required: true
- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria
description: Tell us exactly what's required to complete in order to close this ticket
placeholder: |
Tell us in bullet points what it would it need to be done in order to close this ticket, for example:
1. Ensure that that resource x outputs the correct error message when doing y
1. Reduce timeout on creation of resource x
validations:
required: true
32 changes: 17 additions & 15 deletions .github/ISSUE_TEMPLATE/doc.yml
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
name: Documentation issue
description: Found an issue in the documentation? You can use this one!
title: "[DOCS] <description>"
name: Documentation
description: Issue or improvement suggestions for documentation
title: "[DOCS] describe documentation idea/issue in one line"
labels: ["documentation"]
body:
- type: textarea
id: description
attributes:
label: Description
description: Description of the question or issue, also include what you tried and what didn't work
description: Describe where we can do better documenting this provider
placeholder: |
Please provide the following information here:
1. What information is lacking or incorrect. Or suggestion for improvement.
1. Additional information --> Links to additional resources or examples where you think we could learn from
validations:
required: true
- type: textarea
id: screenshots
id: acceptance-criteria
attributes:
label: Screenshots
description: Screenshots if applicable
label: Acceptance Criteria
description: Tell us exactly what would need to be done to complete this issue
placeholder: |
Tell us in bullet points what it would it need to be done in order to close this ticket, for example:
1. Make it clear what this input is from
1. Provide additional context for x
1. Provide a guide explaining how to do y
validations:
required: false
- type: textarea
id: additional-information
attributes:
label: Additional information
description: Is there anything else we should know about this bug?
validations:
required: false
required: true
33 changes: 18 additions & 15 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -1,26 +1,29 @@
name: General Feature Request
description: Have a new idea/feature? Please suggest!
title: "[FEATURE] <description>"
name: Feature Request
description: Have a new idea/feature for Terraform Provider? Please suggest!
title: "[FEATURE] describe feature in one line"
labels: ["feature"]
body:
- type: textarea
id: description
attributes:
label: Description
description: Description of the enhancement you propose, also include what you tried and what worked.
description: Describe the feature idea
placeholder: |
Please provide the following information here:
1. What's the issue?
1. Why do you think we should implement this feature?
1. Visualize your idea as much as possible so it's easy to understand what you mean.
1. Additional information --> Links to additional resources, for example other tools with similar feature implemented.
validations:
required: true
- type: textarea
id: screenshots
id: acceptance-criteria
attributes:
label: Screenshots
description: Screenshots if applicable
label: Acceptance Criteria
description: Tell us exactly what would need to be done to implement this ticket
placeholder: |
Tell us in bullet points what it would it need to be done in order to close this ticket, for example:
1. Add parameter to optionally not write kubeconfig to state.
1. Make the parameter default
validations:
required: false
- type: textarea
id: additional-information
attributes:
label: Additional information
description: Is there anything else we should know about this bug?
validations:
required: false
required: true
30 changes: 20 additions & 10 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,29 @@
name: Other
description: Use this for any other issues. Please do NOT create blank issues
title: "[OTHER] <description>"
name: Documentation
description: Issue or improvement suggestions for documentation
title: "[OTHER] describe request in one line"
labels: ["other"]
body:
- type: textarea
id: issuedescription
id: description
attributes:
label: What would you like to share?
description: Provide a clear and concise explanation of your issue.
label: Description
description: Describe what you need
placeholder: |
Please provide the following information here:
1. What's the issue/request?
1. Why do you think we should implement this feature?
1. Visualize your idea as much as possible so it's easy to understand what you mean.
1. Additional information --> Links to additional resources, for example other tools with similar feature implemented.
validations:
required: true
- type: textarea
id: additional-information
id: acceptance-criteria
attributes:
label: Additional information
description: Is there anything else we should know about this bug?
label: Acceptance Criteria
description: Tell us exactly what would need to be done to implement this ticket
placeholder: |
Tell us in bullet points what it would it need to be done in order to close this ticket, for example:
1. Add parameter to optionally not write kubeconfig to state.
1. Make the parameter default
validations:
required: false
required: true
31 changes: 0 additions & 31 deletions .github/workflows/ISSUE_TEMPLATE/bug.yml

This file was deleted.

32 changes: 0 additions & 32 deletions .github/workflows/ISSUE_TEMPLATE/feature_request.yml

This file was deleted.

49 changes: 0 additions & 49 deletions .github/workflows/ISSUE_TEMPLATE/other.yml

This file was deleted.

Loading