Skip to content

Commit

Permalink
add issue and pr template
Browse files Browse the repository at this point in the history
  • Loading branch information
paliwalvimal committed Jun 2, 2022
1 parent 7a563ff commit 20d0ffd
Show file tree
Hide file tree
Showing 3 changed files with 132 additions and 0 deletions.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: 🐞 Bug
description: Something isn't working as expected 💔
title: "[Bug] <title>"
labels: ["bug"]
assignees:
- paliwalvimal
body:
- type: checkboxes
attributes:
label: Prerequisites
description: Please answer the following questions for yourself before submitting an issue
options:
- label: I am running the latest version
required: true
- label: I read the documentation properly and found no answer
required: true
- label: I have checked to make sure that this issue has not already been filed
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen
validations:
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing
validations:
required: true
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
Example:
- **Operating System**: Ubuntu 20.04
- **Terraform Version**: 1.4.0
- **Provider version**: v2.16.0 (AWS Provider Version)
- **Module Version**: v1.0.0
value: |
- Operating System:
- Terraform Version:
- Provider version:
- Module Version:
render: markdown
validations:
required: true
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in
validations:
required: false
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: 💡 Feature request
description: I have a suggestion (and may want to implement it 🙂)!
title: "[Feature] <title>"
labels: ["feature", "enhancement"]
body:
- type: checkboxes
attributes:
label: Prerequisites
description: Please answer the following questions for yourself before submitting an issue
options:
- label: I have checked to make sure that this issue has not already been filed
required: true
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe the problem
description: A clear and concise description of what the problem is
validations:
required: false
- type: textarea
attributes:
label: Describe the solution you'd like
description: |
A clear and concise description of what you want to happen
validations:
required: true
- type: textarea
attributes:
label: Describe any alternatives you've considered
description: |
A clear and concise description of any alternative solutions or features you've considered
validations:
required: false
- type: textarea
attributes:
label: Additional context
description: |
Add any other context or screenshots about the feature request here
validations:
required: false
26 changes: 26 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# PR title

<!-- Thank you for submitting a pull request to our repo -->

## Prerequisites
- [ ] There is an open issue for the PR that you are making. If not, please open an issue to discuss the change or find an existing issue.

## What kind of change does this PR introduce? (check one)
- [ ] Bug fix
- [ ] Feature Request

## Does this PR introduce a breaking change? (check one)
- [ ] Yes
- [ ] No

## Description
<!-- Please include a summary of the change and/or which issue is fixed -->

---

## Additional context
<!-- Add any other context or screenshots about the pull request here -->

---

Fixes #{ISSUE_NUMBER}

0 comments on commit 20d0ffd

Please sign in to comment.