Skip to content

Commit

Permalink
Bug report anf Feature request templates
Browse files Browse the repository at this point in the history
  • Loading branch information
vrundakansara committed Oct 23, 2024
1 parent f4cdcb9 commit 330a7c7
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Bug report
description: Report a bug with the Force UI Library
labels: ['[Type] Bug']
body:
- type: textarea
attributes:
label: Description
description: Please write a brief description of the bug, including what you expect to happen and what is currently happening.
placeholder: |
Feature '...' is not working properly. I expect '...' to happen, but '...' happens instead
validations:
required: true

- type: textarea
attributes:
label: Step-by-step reproduction instructions
description: Please write the steps needed to reproduce the bug.
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
validations:
required: true

- type: textarea
attributes:
label: Screenshots, screen recording, code snippet
description: |
If possible, please upload a screenshot or screen recording which demonstrates the bug. You can use LIEcap to create a GIF screen recording: https://www.cockos.com/licecap/
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
If this bug is to related to a developer API, please share a code snippet that demonstrates the issue. For small snippets paste it directly here, or you can use GitHub Gist to share multiple code files: https://gist.github.com
Please ensure the shared code can be used by a developer to reproduce the issue—ideally it can be copied into a local development environment or executed in a browser console to help debug the issue
validations:
required: false

- type: textarea
attributes:
label: Environment info
description: |
Please list what Force UI version you are using.
placeholder: |
- WordPress version, Force UI version, and active Theme you are using.
- Browser(s) are you seeing the problem on.
- Device you are using and operating system (e.g. "Desktop with Windows 10", "iPhone with iOS 14", etc.).
validations:
required: false

- type: checkboxes
id: existing
attributes:
label: Please confirm that you have searched existing issues in the repo.
description: You can do this by searching https://github.com/brainstormforce/force-ui/issues and making sure the bug is not related to another plugin.
options:
- label: 'Yes'
required: true
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: Propose an idea for a feature or an enhancement
labels: "[Type] Enhancement"

---

## What problem does this address?
<!--
Please describe if this feature or enhancement is related to a current problem
or pain point. For example, "I'm always frustrated when ..." or "It is currently
difficult to ...".
-->

## What is your proposed solution?
<!--
Please outline the feature or enhancement that you want and how it addresses any
problem identified above.
-->

## Do you have any refernce that has solved this problem?
<!--
Please share references to any other librarey that has solved this problem.
-->

0 comments on commit 330a7c7

Please sign in to comment.