Skip to content

Commit

Permalink
Adding Bug Report Templates (#1194)
Browse files Browse the repository at this point in the history
This provides two changes:
1) A template for Bug Reports, asking most of the common questions such as PHP/Laravel/Alpine versions, and Theme.  This is to improve the quality of bug reporting
2) A change to the PR Form to set "New Feature Submission" -> (4) to have a checkbox
  • Loading branch information
lrljoe committed May 12, 2023
1 parent f1f7ac7 commit 9504b4f
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 4 deletions.
91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
name: Bug Report
description: Report an Issue or Bug with the Package
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
We're sorry to hear you have a problem. Can you help us solve it by providing the following details, please complete as much of the form as possible!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: What did you expect to happen?
placeholder: I cannot currently do X thing, I get Y error message
validations:
required: true
- type: textarea
id: how-to-reproduce
attributes:
label: How to reproduce the bug
description: How did this occur, advise the set of reliable steps if possible.
placeholder: When I do X I see Y.
validations:
required: false
- type: input
id: package-version
attributes:
label: Package Version
description: What version of our Package are you running? Please be as specific as possible
placeholder: 2.12.0
validations:
required: false
- type: dropdown
id: php-version
attributes:
label: PHP Version
description: What version of PHP are you running? Please be as specific as possible
multiple: false
options:
- < 7.4
- 7.4.x
- 8.0.x
- 8.1.x
- 8.2.x
- 8.3.x
validations:
required: false
- type: input
id: laravel-version
attributes:
label: Laravel Version
description: What version of Laravel are you running? Please be as specific as possible
placeholder: 10.0.0
validations:
required: false
- type: input
id: alpine-version
attributes:
label: Alpine Version
description: What version of AlpineJS are you running? Please be as specific as possible
placeholder: 3.1.12
validations:
required: false
- type: dropdown
id: theme
attributes:
label: Theme
description: Which theme are you using?
multiple: false
options:
- Tailwind 2.x
- Tailwind 3.x
- Bootstrap 4.x
- Bootstrap 5.x
validations:
required: false
- type: textarea
id: notes
attributes:
label: Notes
description: Use this field to provide any other notes that you feel might be relevant to the issue.
validations:
required: false
- type: textarea
id: error-message
attributes:
label: Error Message
description: Use this field to provide any error messages that you receive
validations:
required: false
3 changes: 0 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,3 @@ contact_links:
- name: Request a feature
url: https://github.com/rappasoft/laravel-livewire-tables/discussions/new?category=ideas
about: Share ideas for new features
- name: Report a bug
url: https://github.com/rappasoft/laravel-livewire-tables/issues/new
about: Report a reproducable bug
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
1. [ ] Does your submission pass tests and did you add any new tests needed for your feature?
2. [ ] Did you update all templates (if applicable)?
3. [ ] Did you add the [relevant documentation](https://github.com/rappasoft/laravel-livewire-tables-docs) (if applicable)?
4. Did you test locally to make sure your feature works as intended?
4. [ ] Did you test locally to make sure your feature works as intended?

### Changes to Core Features:

Expand Down

0 comments on commit 9504b4f

Please sign in to comment.