Skip to content

Commit 1dcb6d4

Browse files
Improve GitHub templates (#3905)
* Improve GitHub templates - Make bug report outcome summary required for better issue quality - Make logs/errors optional to reduce friction for simple bugs - Fix CONTRIBUTING.md path in PR template (../../ instead of ../) * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Matt Rubens <[email protected]> * Update .github/pull_request_template.md Co-authored-by: Matt Rubens <[email protected]> --------- Co-authored-by: Matt Rubens <[email protected]>
1 parent 5ab78b3 commit 1dcb6d4

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,18 @@ body:
7171
- type: textarea
7272
id: what-happened
7373
attributes:
74-
label: 💥 Outcome Summary (Optional)
74+
label: 💥 Outcome Summary
7575
description: |
76-
Recap what went wrong in one or two lines. Use this if the bug is weird, unexpected, or needs extra context.
76+
Recap what went wrong in one or two lines.
7777
7878
Example: "Expected code to run, but got an empty response and no error."
7979
placeholder: Expected ___, but got ___.
80+
validations:
81+
required: true
8082

8183
- type: textarea
8284
id: logs
8385
attributes:
84-
label: 📄 Relevant Logs or Errors
86+
label: 📄 Relevant Logs or Errors (Optional)
8587
description: Paste API logs, terminal output, or errors here. Use triple backticks (```) for code formatting.
8688
render: shell

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Detail the steps to test your changes. This helps reviewers verify your work.
6161
- [ ] **Branch Hygiene**: My branch is up-to-date (rebased) with the `main` branch.
6262
- [ ] **Documentation Impact**: I have considered if my changes require documentation updates (see "Documentation Updates" section below).
6363
- [ ] **Changeset**: A changeset has been created using `npm run changeset` if this PR includes user-facing changes or dependency updates.
64-
- [ ] **Contribution Guidelines**: I have read and agree to the [Contributor Guidelines](../CONTRIBUTING.md).
64+
- [ ] **Contribution Guidelines**: I have read and agree to the [Contributor Guidelines](/CONTRIBUTING.md).
6565

6666
### Screenshots / Videos
6767

0 commit comments

Comments
 (0)