Răsfoiți Sursa

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]>
Hannes Rudolph 10 luni în urmă
părinte
comite
1dcb6d4a8e

+ 5 - 3
.github/ISSUE_TEMPLATE/bug_report.yml

@@ -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

+ 1 - 1
.github/pull_request_template.md

@@ -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