Skip to content

Commit

Permalink
docs: add templates (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
joshblack authored Feb 9, 2024
1 parent c4a5143 commit c3a0476
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 0 deletions.
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Bug report 🐛
description: Something not working as expected? This is the place to report your issue.
labels:
- 'bug'
body:
- type: markdown
attributes:
value: |
# Hi there! :wave:
Thanks for taking the time to fill out this bug report.
- type: textarea
id: description
attributes:
label: Description
description: "Tell us more about the problem that you're running into."
placeholder: What did you see? What did you expect to see?
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce
description: 'How do we reproduce the error you described above?'
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: 'What version of `@primer/live-region-element` are you using?'
placeholder: v1.0.0
validations:
required: true
- type: dropdown
id: browser
attributes:
label: Browser
description: In which browser(s) are you experiencing the issue?
multiple: true
options:
- Chrome
- Safari
- Firefox
- Edge
- iOS Safari
- type: dropdown
id: screen-reader
attributes:
label: Screen reader
description: In which screen reader(s) are you experiencing the issue?
multiple: true
options:
- JAWS
- NVDA
- VoiceOver on macOS
- VoiceOver on iOS
- Narrator
- Other
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Closes #

<!-- Short description of the PR. What does it do? -->

#### Changelog

**New**

<!-- List of things added in this PR -->

**Changed**

<!-- List of things changed in this PR -->

**Removed**

<!-- List of things removed in this PR -->

#### Testing & Reviewing

<!-- Add descriptions, steps or a checklist for how reviewers can verify this PR works or not -->

0 comments on commit c3a0476

Please sign in to comment.