From af51057d529c962c7a9b9dfc52d4020c50432b6a Mon Sep 17 00:00:00 2001 From: Jason Lee Date: Mon, 24 Nov 2025 11:39:57 +0800 Subject: [PATCH] chore: Add issue and pull request template. --- .github/ISSUE_TEMPLATE/01_bug.md | 36 ++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/01_bug_fix.md | 42 +++++++++++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01_bug.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/01_bug_fix.md diff --git a/.github/ISSUE_TEMPLATE/01_bug.md b/.github/ISSUE_TEMPLATE/01_bug.md new file mode 100644 index 00000000..94d7b857 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_bug.md @@ -0,0 +1,36 @@ +--- +name: Bug report +about: Report a problem or unexpected behavior +title: "" +labels: bug, triage +assignees: +--- + +## Description + +Use English with clear and concise description of the bug, if you just have a question or need help, please submit to [Discussions](https://github.com/longbridge/gpui-component/discussions/categories/q-a). + +## Environment + +- OS: [e.g., macOS, Windows, Linux] +- Browser: [e.g., Chrome, Firefox, Safari] +- Version: [e.g., 1.0.0] + +## Steps to Reproduce + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +## Screenshots + +If applicable, add screenshots to help explain your problem. + +## Expected + +A clear and concise description of what you expected to happen. + +## Actual + +A clear and concise description of what actually happened. diff --git a/.github/PULL_REQUEST_TEMPLATE/01_bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/01_bug_fix.md new file mode 100644 index 00000000..3650855e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/01_bug_fix.md @@ -0,0 +1,42 @@ +--- +name: Pull Request +about: Submit a pull request to fix a bug or add a feature. +title: "[component name]: Fix [short description]" +labels: enhancement, review-needed +assignees: +--- + +Closes #[issue number] + +## Description + +Describe in English for the changes made in this pull request and the problem it solves. +Please keep **1 PR to solve 1 problem**, and keep **Small improvements should be small modifications** to make PR easier to review and to merge. + +## Screenshot + +| Before | After | +| ---------------------------- | --------------------------- | +| [Put Before Screenshot here] | [Put After Screenshot here] | + +## Break Changes + +Describe any breaking changes introduced by this pull request. If none, remove this section. + +- Change 1 + +```diff +- Old code snippet ++ New code snippet +``` + +## How to Test + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. + +## Checklist + +- [ ] I have read the [CONTRIBUTING](../CONTRIBUTING.md) document and followed the guidelines. +- [ ] Reviewed the changes in this PR and confirmed AI generated code (If any) is accurate. +- [ ] Passed `cargo run` for story tests related to the changes. +- [ ] Tested macOS, Windows and Linux platforms performance (if the change is platform-specific)