Skip to content

Commit 7488e30

Browse files
committed
chore: add issue and pull request templates
Public contributors need a clear intake path for bugs, website change requests, and pull requests. The templates ask for maintainer review context without making the PR form heavy. Constraint: Templates should stay lightweight for OSS contributors Rejected: Large PR checkbox grid | too much friction for small website changes Confidence: high Scope-risk: narrow Reversibility: clean Tested: pnpm format; pnpm lint; pnpm typecheck; pnpm spell Tested: pnpm test; pnpm build; YAML parse for issue forms Tested: pnpm exec playwright test --project=firefox --reporter=list Not-tested: GitHub rendered form preview
1 parent 0704a01 commit 7488e30

4 files changed

Lines changed: 182 additions & 0 deletions

File tree

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
name: Bug report
2+
description: Report a problem on the Zen Browser website
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting a website issue. Please include enough detail for maintainers to reproduce it.
10+
11+
Please search open and closed issues before submitting. Someone might have reported the same thing already.
12+
13+
- type: input
14+
id: page
15+
attributes:
16+
label: Affected page
17+
description: Paste the URL or route where the issue appears.
18+
placeholder: "https://zen-browser.app/download"
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: problem
24+
attributes:
25+
label: What happened?
26+
description: Describe the visible problem or broken behavior.
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: expected
32+
attributes:
33+
label: Expected behavior
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: reproduce
39+
attributes:
40+
label: Steps to reproduce
41+
placeholder: |
42+
1. Open ...
43+
2. Click ...
44+
3. See ...
45+
validations:
46+
required: true
47+
48+
- type: dropdown
49+
id: area
50+
attributes:
51+
label: Area
52+
options:
53+
- Home / marketing pages
54+
- Download page
55+
- Release notes / what's new
56+
- Mods pages
57+
- Navigation / layout
58+
- Translations
59+
- Build / CI
60+
- Other
61+
validations:
62+
required: true
63+
64+
- type: input
65+
id: browser
66+
attributes:
67+
label: Browser and device
68+
placeholder: "Firefox 145 on macOS, Safari on iPhone, etc."
69+
70+
- type: checkboxes
71+
id: ai_use
72+
attributes:
73+
label: AI use
74+
options:
75+
- label: I did not use AI to create this issue.
76+
- label: If there is no check above, I reviewed the generated content before submitting.
77+
78+
- type: textarea
79+
id: screenshots
80+
attributes:
81+
label: Screenshots or recordings
82+
description: Drag screenshots, videos, or logs here if useful.
83+
84+
- type: textarea
85+
id: extra
86+
attributes:
87+
label: Additional context
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Website change request
2+
description: Suggest a content, UI, translation, or website improvement
3+
title: "[Change]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a website improvement.
10+
11+
Please search open and closed issues before submitting. Someone might have requested the same thing already.
12+
13+
- type: dropdown
14+
id: area
15+
attributes:
16+
label: Area
17+
options:
18+
- Content / copy
19+
- UI / visual design
20+
- Download page
21+
- Release notes / what's new
22+
- Mods pages
23+
- Translations
24+
- Accessibility
25+
- Build / tooling
26+
- Other
27+
validations:
28+
required: true
29+
30+
- type: input
31+
id: page
32+
attributes:
33+
label: Related page or route
34+
placeholder: "https://zen-browser.app/..."
35+
36+
- type: textarea
37+
id: proposal
38+
attributes:
39+
label: Proposed change
40+
description: What should change?
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: reason
46+
attributes:
47+
label: Why is this useful?
48+
description: Explain the user-facing benefit or problem this solves.
49+
validations:
50+
required: true
51+
52+
- type: checkboxes
53+
id: ai_use
54+
attributes:
55+
label: AI use
56+
options:
57+
- label: I did not use AI to create this issue.
58+
- label: If there is no check above, I reviewed the generated content before submitting.
59+
60+
- type: textarea
61+
id: details
62+
attributes:
63+
label: Implementation notes
64+
description: Optional screenshots, copy suggestions, links, or technical details.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Contributing guide
4+
url: https://docs.zen-browser.app/contribute/www
5+
about: Read this before opening a contribution PR.

.github/pull_request_template.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Related issue
2+
3+
<!-- Use "Closes #123", "Fixes #123", "Related #123", or "No linked issue". -->
4+
5+
## Summary
6+
7+
<!-- What changed, and why? Keep this short. -->
8+
9+
## Affected area
10+
11+
<!-- Example: home page, download page, release notes, mods, navigation, translations, tests, CI. -->
12+
13+
## Screenshots or preview
14+
15+
<!-- Required for visible UI changes. Add before/after screenshots, recordings, or a preview URL. -->
16+
17+
## AI use
18+
19+
<!-- Disclose AI-assisted code, copy, translations, screenshots, or other submitted content. -->
20+
21+
- [ ] No AI tools were used.
22+
- [ ] AI tools were used, and I reviewed the output for accuracy, licensing, and project fit.
23+
24+
## Verification
25+
26+
<!-- List the commands or checks you ran. -->

0 commit comments

Comments
 (0)