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 <mrubens@users.noreply.github.com>

* Update .github/pull_request_template.md

Co-authored-by: Matt Rubens <mrubens@users.noreply.github.com>

---------

Co-authored-by: Matt Rubens <mrubens@users.noreply.github.com>
This commit is contained in:
Hannes Rudolph 2025-05-23 17:02:28 -06:00 committed by GitHub
parent 5ab78b37c0
commit 1dcb6d4a8e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 6 additions and 4 deletions

View file

@ -71,16 +71,18 @@ body:
- type: textarea
id: what-happened
attributes:
label: 💥 Outcome Summary (Optional)
label: 💥 Outcome Summary
description: |
Recap what went wrong in one or two lines. Use this if the bug is weird, unexpected, or needs extra context.
Recap what went wrong in one or two lines.
Example: "Expected code to run, but got an empty response and no error."
placeholder: Expected ___, but got ___.
validations:
required: true
- type: textarea
id: logs
attributes:
label: 📄 Relevant Logs or Errors
label: 📄 Relevant Logs or Errors (Optional)
description: Paste API logs, terminal output, or errors here. Use triple backticks (```) for code formatting.
render: shell

View file

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