[close #405] update PR and issue template (#406)

This commit is contained in:
Jian Zhang 2021-12-15 13:05:14 +08:00 committed by GitHub
parent cc9f3b62e6
commit 1af9f95985
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 62 additions and 52 deletions

View File

@ -1,30 +1,24 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] Title of Bug Report"
name: "\U0001F41B Bug Report"
about: As a User, I want to report a Bug.
labels: type/bug
assignees: ''
---
**Describe the bug**
## Bug Report
### 1. Describe the bug
<!-- A clear and concise description of what the bug is. -->
**What did you do**
<!--
If possible, please provide a code receipt to produce this issue.
-->
### 2. Minimal reproduce step (Required)
**What do you expect**
<!-- A clear and concise description of what you expected to happen. -->
<!-- a step by step guide for reproducing the bug. -->
**What happens instead**
<!-- If an error occurs, please provide complete error stack. -->
### 3. What did you see instead (Required)
<!--
**Screenshots**
If applicable, add screenshots to help explain your problem.
-->
### 4. What did you expect to see? (Required)
**Java Client and TiDB/TiKV version info**
### 5. What is your Java Client and TiKV version? (Required)
- Client Java:
- TiKV:

View File

@ -1,20 +1,23 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
name: "\U0001F680 Feature Request"
about: As a user, I want to request a New Feature on the product.
labels: type/feature-request
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
## Feature Request
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Is your feature request related to a problem? Please describe:**
<!-- A clear and concise description of what the problem is. Ex. I'm always
frustrated when [...] -->
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Describe the feature you'd like:**
<!-- A clear and concise description of what you want to happen. -->
**Additional context**
Add any other context or screenshots about the feature request here.
**Describe alternatives you've considered:**
<!-- A clear and concise description of any alternative solutions or features
you've considered. -->
**Teachability, Documentation, Adoption, Migration Strategy:**
<!-- If you can, explain some scenarios how users might use this, situations it
would be helpful in. Any API designs, mockups, or diagrams are also helpful.
-->

View File

@ -1,33 +1,46 @@
### What problem does this PR solve? <!--add issue link with summary if exists-->
<!-- Thank you for contributing to TiKV Java Client!
PR Title Format: "[close/to/fix #issue_number] summary" -->
### What problem does this PR solve?
Issue Number: close #issue_number
Problem Description: **TBD**
### What is changed and how it works?
### Check List <!--REMOVE the items that are not applicable-->
Tests <!-- At least one of them must be included. -->
### Code changes
- Unit test
- Integration test
- Manual test (add detailed scripts or steps below)
- No code
<!-- REMOVE the items that are not applicable -->
- Has exported function/method change
- Has exported variable/fields change
- Has interface methods change
- Has persistent data change
- No code
Code changes
### Check List for Tests
- Has exported function/method change
- Has exported variable/fields change
- Has interface methods change
- Has persistent data change
This PR has been tested by the at least one of the following methods:
- Unit test
- Integration test
- Manual test (add detailed scripts or steps below)
- No code
Side effects
### Side effects
- Possible performance regression
- Increased code complexity
- Breaking backward compatibility
<!-- REMOVE the items that are not applicable -->
- Possible performance regression, WHY: **TBD**
- Increased code complexity, WHY: **TBD**
- Breaking backward compatibility, WHY: **TBD**
- NO side effects
Related changes
### Related changes
- Need to cherry-pick to the release branch
- Need to update the documentation
- Need to be included in the release note
<!-- REMOVE the items that are not applicable -->
- Need to cherry-pick to the release branch
- Need to update the documentation
- Need to be included in the release note
- NO related changes