Skip to content

Commit 19c56e7

Browse files
authored
Add issue templates to GitHub (#206)
1 parent 5431064 commit 19c56e7

File tree

3 files changed

+107
-0
lines changed

3 files changed

+107
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Bug Report
2+
description: If something isn't working as expected and you're sure your issue is reproducible, please file this type of issue!
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
# Version number
7+
- type: input
8+
id: version
9+
attributes:
10+
label: ArchiveWeb.page Version
11+
description: "This can be found on the app home page under \"About\""
12+
placeholder: "v0.11.3"
13+
validations:
14+
required: true
15+
# What did the user expect to happen? What was the actual behavior?
16+
- type: textarea
17+
attributes:
18+
label: What did you expect to happen? What happened instead?
19+
description: |
20+
"I was trying to archive a page however..."
21+
22+
Please submit any screenshots/videos that can be used to understand how to reproduce the issue. You can attach images by clicking this area to highlight it and then dragging files into the browser window.
23+
24+
If something wasn't captured in the way you expect please include a link to the archived item if possible.
25+
validations:
26+
required: true
27+
# Step-by-step reproduction instructions
28+
- type: textarea
29+
attributes:
30+
label: Step-by-step reproduction instructions
31+
placeholder: |
32+
1. Navigate to...
33+
2. Click on...
34+
3. See error...
35+
validations:
36+
required: true
37+
# Additional details
38+
- type: textarea
39+
attributes:
40+
label: Additional details
41+
description: Add any other relevant information here.
42+
validations:
43+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Allow issues to be created without a template
2+
blank_issues_enabled: true
3+
4+
contact_links:
5+
- name: Report a replay issue
6+
about: Issues related to archived content not displaying properly should be reported in the ReplayWeb.page repo.
7+
url: https://github.com/webrecorder/replayweb.page/issues/new?&labels=replay+bug%2Cbug&projects=&template=replay-bug.yml&title=[Replay+Bug]%3A+
8+
- name: Report a security vulnerability
9+
about: Please do not file an issue and instead email security@webrecorder.org. We will follow up with you there!
10+
url: https://webrecorder.net/.well-known/security.txt
11+
- name: Get help on our forum
12+
url: https://forum.webrecorder.net/
13+
about: Have a ("how do I...?") question? Not sure if your issue is reproducible? The best way to get help is on our community forum!
14+
- name: Check out the docs
15+
url: https://archiveweb.page/guide
16+
about: Solutions to common questions may be available in the documentation!
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Feature / Change Request
2+
description: If new things should be added or something that is working as intended should be changed, please file this type of issue!
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
# Context
7+
- type: textarea
8+
attributes:
9+
label: Context
10+
description: Describe any prior information that we are taking into account to inform this future development.
11+
placeholder: "Now that x is done we should do y to accomplish z."
12+
validations:
13+
required: true
14+
# User story sentence
15+
- type: textarea
16+
attributes:
17+
label: What change would you like to see?
18+
description: Describe the solution you'd like. If relevant, include ways in which you've tried to solve the issue with the current version.
19+
placeholder: "As a user, I want to be able to ____ so that I can ____"
20+
validations:
21+
required: true
22+
# Requirements
23+
- type: textarea
24+
attributes:
25+
label: Requirements
26+
description: |
27+
Intended primarily for use by Webrecorder team, leave blank if unknown.
28+
29+
List the outcomes of the feature being implemented without design or implementation details.
30+
placeholder: |
31+
1. Item metadata should show links to the collections that the item belongs to.
32+
2. Items can be added or removed from collections when editing an item.
33+
validations:
34+
required: false
35+
# Todo
36+
- type: textarea
37+
attributes:
38+
label: Todo
39+
description: |
40+
Intended primarily for use by Webrecorder team, leave blank if unknown.
41+
42+
Any other linked issues / tasks to complete to implement this feature.
43+
placeholder: |
44+
- [ ] Mockups:
45+
- [ ] Design:
46+
- [ ] UI:
47+
validations:
48+
required: false

0 commit comments

Comments
 (0)