Skip to content

Commit

Permalink
*: refine github templates (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
xhebox authored Jul 25, 2022
1 parent 64a12cd commit d90e307
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 35 deletions.
21 changes: 13 additions & 8 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
---
name: "🐛 Bug Report"
about: Something isn't working as expected
labels: 'type/bug'
about: As a User, I want to report a Bug.
labels: type/bug
---

## Bug Report

<!-- Please answer these questions before submitting your issue. Thanks! -->
Please answer these questions before submitting your issue. Thanks!

### What did you do?
### 1. Minimal reproduce step (Required)

<!-- If possible, provide a recipe for reproducing the error. -->
<!-- a step by step guide for reproducing the bug. -->

### What did you expect to see?
### 2. What did you expect to see? (Required)

### What did you see instead?
### 3. What did you see instead (Required)

### 4. What is your version? (Required)

<!-- Paste the output of weirproxy -V -->
<!-- Paste the output of weirctl -V if related -->
<!-- Paste the output of SELECT tidb_version() if related -->

### What version of Weir are you using (`weir-proxy -V`)?
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/development-task.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: "🗒️ Development Task"
about: As a developer, I want to record a development task.
labels: type/enhancement
labels: type/development
---

## Development Task
56 changes: 30 additions & 26 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,53 @@
<!--
Thank you for working on Weir! Please read Weir's [CONTRIBUTING](https://github.com/tidb-incubator/weir/blob/master/CONTRIBUTING.md) document **BEFORE** filing this PR.
Thank you for contributing to Weir!
PR Title Format:
1. pkg [, pkg2, pkg3]: what's changed
2. *: what's changed
-->

### What problem does this PR solve?
<!--
<!-- Add the issue link with a summary if it exists. -->
Please create an issue first to describe the problem.
### What is changed and how it works?
There MUST be one line starting with "Issue Number: " and
linking the relevant issues via the "close: #xxx" or "ref: #xxx".
### Check List
For more info, check https://pingcap.github.io/tidb-dev-guide/contribute-to-tidb/contribute-code.html#referring-to-an-issue.
<!-- Remove the items that are not applicable. -->

Tests
-->

<!-- At least one of them must be included. -->
Issue Number: close #xxx

- Unit test
- Integration test
- Manual test (add detailed scripts or steps below)
- No code
Problem Summary:

Code changes
What is changed and how it works:

- Has configuration change
- Has HTTP API interfaces change (Don't forget to [add the declarative for API](https://github.com/tikv/pd/blob/master/docs/development.md#updating-api-documentation))
- Has persistent data change
### Check List

Side effects
Tests <!-- At least one of them must be included. -->

- Possible performance regression
- Increased code complexity
- Breaking backward compatibility
- [ ] Unit test
- [ ] Integration test
- [ ] Manual test (add detailed scripts or steps below)
- [ ] No code

Related changes
Notable changes

- PR to update [`pingcap/docs`](https://github.com/pingcap/docs)/[`pingcap/docs-cn`](https://github.com/pingcap/docs-cn):
- PR to update [`pingcap/tidb-ansible`](https://github.com/pingcap/tidb-ansible):
- Need to cherry-pick to the release branch
- [ ] Has configuration change
- [ ] Has HTTP API interfaces change (Don't forget to [add the declarative for API](https://github.com/tikv/pd/blob/master/docs/development.md#updating-api-documentation))
- [ ] Has weirctl change
- [ ] Other user behavior changes

### Release note

<!-- A bugfix or a new feature needs a release note. If there is no need release note, just uncomment the below line. -->
<!-- compatibility change, improvement, bugfix, and new feature need a release note -->

Please refer to [Release Notes Language Style Guide](https://pingcap.github.io/tidb-dev-guide/contribute-to-tidb/release-notes-style-guide.html) to write a quality release note.

<!-- - No release note -->
```release-note
None
```

0 comments on commit d90e307

Please sign in to comment.