chore: Add issue and pull request template.
This commit is contained in:
parent
fc36451a27
commit
af51057d52
2 changed files with 78 additions and 0 deletions
36
.github/ISSUE_TEMPLATE/01_bug.md
vendored
Normal file
36
.github/ISSUE_TEMPLATE/01_bug.md
vendored
Normal file
|
|
@ -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.
|
||||||
42
.github/PULL_REQUEST_TEMPLATE/01_bug_fix.md
vendored
Normal file
42
.github/PULL_REQUEST_TEMPLATE/01_bug_fix.md
vendored
Normal file
|
|
@ -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)
|
||||||
Loading…
Reference in a new issue