Skip to content

Commit

Permalink
Add: Issue templates and pull_request.yml (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
Abhay authored Jan 27, 2025
1 parent a129b49 commit 27496d3
Show file tree
Hide file tree
Showing 3 changed files with 139 additions and 0 deletions.
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: 🐛 Bug
description: Create a report to help us improve
title: "🐛 Bug: "
labels: ["🐛 Bug", "Status: Triage"]
body:
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is
validations:
required: true
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Go to'...'
2. Click on'...'
3. Scroll down to'...'
4. See error
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen
validations:
required: true
- type: textarea
attributes:
label: Screenshots
description: |
If applicable, add screenshots to help explain your problem
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in
validations:
required: false
- type: textarea
attributes:
label: Device Information [optional]
description: |
examples:
- **OS**: Ubuntu 20.04
- **Browser**: chrome
- **version**: 22
value: |
- OS:
- Browser:
- version:
render: markdown
validations:
required: false
- type: dropdown
attributes:
label: Are you working on this issue?
options:
- 'Yes'
- 'No'
validations:
required: true
- type: dropdown
attributes:
label: Do you think this work might require an [Architectural Decision Record (ADR)]? (significant or noteworthy)
options:
- 'Yes'
- 'No'
validations:
required: true
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: ⭐️ Feature request
description: Suggest an idea for this project
title: "✨ Enhancement: "
labels: ["✨ Enhancement", "Status: Triage"]
body:
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe
description: A clear and concise description of what the problem is
validations:
required: true
- 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 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 about the problem here
validations:
required: false
- type: dropdown
attributes:
label: Are you working on this?
options:
- 'Yes'
- 'No'
validations:
required: true
34 changes: 34 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@

<!-- In order to keep off topic discussion to a minimum, it helps if the "work to be done" is already agreed on. -->
<!-- Ideally, a GitHub Issue with the label `Status: Consensus` will have been concluded, and linked to in this PR. -->
<!--
Thanks for submitting a pull request! Please provide enough information so that others can review your pull request.
-->

**What kind of change does this PR introduce?**

<!-- E.g. a bugfix, feature, refactoring, etc… -->

**Issue Number:**
<!-- Pick one of the below options. Please remove those which don't apply. -->
- Closes #___ <!-- Replace ___ with the issue number this PR resolves -->
- Related to #___ <!-- Use when the PR doesn't completely resolve an issue -->
- Others? <!-- Add any additional notes or references here -->


**Screenshots/videos:**

<!--Add screenshots or videos wherever possible.-->

**If relevant, did you update the documentation?**

<!--Add link to it-->

**Summary**

<!-- Explain the motivation for making this change. What existing problem does the pull request solve? -->
<!-- Try to link to an open issue for more information. -->

**Does this PR introduce a breaking change?**

<!-- If this PR introduces a breaking change, please describe the impact and a migration path for existing applications. -->

0 comments on commit 27496d3

Please sign in to comment.