Skip to content

Commit

Permalink
chore: add ISSUE_TEMPLATES (#755)
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-siek committed Jun 21, 2023
1 parent bfa2328 commit 6559234
Show file tree
Hide file tree
Showing 5 changed files with 148 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Join the axe Slack Community
url: https://accessibility.deque.com/axe-community
about: Connect with other people passionate about digital accessibility and axe tools.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Improve our documentation
description: Report issues in our documentation or things we could document better.
labels: ['docs', 'ungroomed']
body:
- type: markdown
attributes:
value: |
Documentation reports can be made for axe-core npm integrations (e.g. `@axe-core/webdriverjs`).
- type: dropdown
id: product
attributes:
label: Product
description: Which product is the documentation report for?
options:
- cli
- playwright
- puppeteer
- react
- reporter-earl
- webdriverio
- webdriverjs
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
validations:
required: true
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Request a feature
description: Request an enhancement, improvement, or new rule.
labels: ['feat', 'ungroomed']
body:
- type: markdown
attributes:
value: |
Feature requests can be made for axe-core npm integrations (e.g. `@axe-core/webdriverjs`).
- type: dropdown
id: product
attributes:
label: Product
description: Which product is the feature for?
options:
- cli
- playwright
- puppeteer
- react
- reporter-earl
- webdriverio
- webdriverjs
validations:
required: true
- type: textarea
id: description
attributes:
label: Feature Description
description: What do you wish the product did?
validations:
required: true
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/possible-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Report an issue
description: Report a bug or an issue that you've encountered.
labels: ['ungroomed']
body:
- type: markdown
attributes:
value: |
Thanks for reporting an issue to one of our products. Please provide all necessary information to reproduce the issue. Without adequate details, your issue may be closed without investigation.
Issues can be made for axe-core npm integrations (e.g. `@axe-core/webdriverjs`).
- type: dropdown
id: product
attributes:
label: Product
description: Which product did you encounter the issue?
options:
- cli
- playwright
- puppeteer
- react
- reporter-earl
- webdriverio
- webdriverjs
validations:
required: true
- type: input
id: version
attributes:
label: Product Version
description: For the integration please check the `package.json` file
- type: checkboxes
id: latest-axe
attributes:
label: Latest Version
options:
- label: I have tested the issue with the latest version of the product
required: true
- type: textarea
id: description
attributes:
label: Issue Description
description: Please include a description of the issue and a page or code snippet where it can be reproduced.
value: |
#### Expectation
Describe what you expected the product to do.
#### Actual
Describe what the product actually does.
#### How to Reproduce
Provide a code sample or link to a webpage that reproduces the issue. Without this, your issue may be closed without investigation.
#### Additional context
Any thing else we should know about the issue?
validations:
required: true
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Ask a question
description: General questions for us, the product, or why things are the way they are.
labels: ['question', 'ungroomed']
body:
- type: markdown
attributes:
value: |
Questions can be made for axe-core npm integrations (e.g. `@axe-core/webdriverjs`).
- type: dropdown
id: product
attributes:
label: Product
description: Which product is the question for?
options:
- cli
- playwright
- puppeteer
- react
- reporter-earl
- webdriverio
- webdriverjs
validations:
required: true
- type: textarea
id: question
attributes:
label: Question
validations:
required: true

0 comments on commit 6559234

Please sign in to comment.