Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

Commit

Permalink
Merge pull request #4 from Devanshukoli/devanshu
Browse files Browse the repository at this point in the history
Add Issue Template & PR Template
  • Loading branch information
Pan-cakse authored Oct 3, 2024
2 parents a1abbd8 + 960b8ab commit 260c255
Show file tree
Hide file tree
Showing 3 changed files with 166 additions and 0 deletions.
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: 🐛 Bug
description: Report an issue to help improve the project.
title: "[BUG] <description>"
labels: ["🛠 goal: fix", "🚦 status: awaiting triage"]
body:
- type: checkboxes
id: duplicates
attributes:
label: Has this bug been raised before?
description: Increase the chances of your issue being accepted by making sure it has not been raised before.
options:
- label: I have checked "open" AND "closed" issues and this is not a duplicate
required: true
- type: input
attributes:
label: Where did you find this bug?
description: Local dev environment or live website.
validations:
required: true
- type: input
attributes:
label: Version of website/mobile (for example "v1.2.3")
description: Can be found in the lower right corner of the web interface in the footer. Or you can check in github repository.
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: A clear description of the bug you have found. Please include relevant information and resources (for example the steps to reproduce the bug)
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: To help us recreate the bug, provide a numbered list of the exact steps taken to trigger the buggy behavior.
value: |
If you know the steps, follow the below format and provide steps to reproduce
For example:
1. Go to <replace your> page.
1. On top right side, close to the <Account> menu
1. Some menu are not working properly.
1. Continue...
If you don't know exact steps, include any relevant details like:
- What page you were on...
- What you were trying to do...
- What went wrong...
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Please add screenshots if applicable
validations:
required: false
- type: dropdown
id: assignee
attributes:
label: Do you want to work on this issue?
multiple: false
options:
- "No"
- "Yes"
default: 0
validations:
required: false
- type: textarea
id: extrainfo
attributes:
label: If "yes" to above, please explain how you would technically implement this
description: For example reference any existing code
validations:
required: false
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: 💡 General Feature Request
description: Have a new idea/feature for IceCream? Let us know...
title: "[FEATURE] <description>"
labels: ["⭐ goal: addition", "🚦 status: awaiting triage"]
body:
- type: checkboxes
id: duplicates
attributes:
label: Is this a unique feature?
description: Increase the chances of your issue being accepted by making sure it has not been raised before.
options:
- label: I have checked "open" AND "closed" issues and this is not a duplicate
required: true
- type: textarea
attributes:
label: Is your feature request related to a problem/unavailable functionality? Please describe.
description: A clear and concise description of what the problem is (for example "I'm always frustrated when [...]").
validations:
required: true
- type: textarea
id: description
attributes:
label: Proposed Solution
description: A clear description of the enhancement you propose. Please include relevant information and resources (for example another project's implementation of this feature).
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Please add screenshots of the before and/or after the proposed changes.
validations:
required: false
- type: dropdown
id: assignee
attributes:
label: Do you want to work on this issue?
multiple: false
options:
- "No"
- "Yes"
default: 0
validations:
required: false
- type: textarea
id: extrainfo
attributes:
label: If "yes" to above, please explain how you would technically implement this
description: For example reference any existing code
validations:
required: false
36 changes: 36 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!-- If your PR fixes an open issue, use `Closes #999` to link your PR with the issue. #999 stands for the issue number you are fixing -->

## Fixes Issue

<!-- Remove this section if not applicable -->

<!-- Example: Closes #31 -->

## Changes proposed

<!-- List all the proposed changes in your PR -->

<!-- Mark all the applicable boxes. To mark the box as done follow the following conventions -->
<!--
[x] - Correct; marked as done
[X] - Correct; marked as done
[ ] - Not correct; marked as **not** done
-->

## Check List (Check all the applicable boxes) <!-- Follow the above conventions to check the box -->

- [ ] My code follows the code style of this project.
- [ ] My change requires changes to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] All new and existing tests passed.
- [ ] This PR does not contain plagiarized content.
- [ ] The title of my pull request is a short description of the requested changes.

## Screenshots

<!-- Add all the screenshots which support your changes -->

## Note to reviewers

<!-- Add notes to reviewers if applicable -->

0 comments on commit 260c255

Please sign in to comment.