Skip to content

Commit

Permalink
.github: add issue&PR template (#329)
Browse files Browse the repository at this point in the history
  • Loading branch information
zz-jason authored Mar 3, 2020
1 parent 02098e7 commit 4af66e1
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: "\U0001F41B Bug Report"
about: something isn't working as expected
labels: type/bug
---

## Bug Report

Please answer these questions before submitting your issue. Thanks!

### 1. What did you do? <!-- provide a recipe for reproducing -->

### 2. What did you expect to see?

### 3. What did you see instead?
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-requirement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: "\U0001F680 Feature Request"
about: I have a suggestion!
labels: type/enhancement
---

## Feature Request

please make a clear and concise description for the following questions.

### Is your feature request related to a problem?
<!-- what the problem is -->

### Describe the feature you'd like
<!-- what you want to happen. -->

### Describe alternatives you've considered
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: "\U0001F914 Question"
about: I have a question!
labels: type/question
---

## General Question

## Tips

Expect for asking questions on Github, you can also discuss it in the channel
**#wg-talent-plan-courses**. of
[tidbcommunity](https://join.slack.com/t/tidbcommunity/shared_invite/enQtNzc0MzI4ODExMDc4LWYwYmIzMjZkYzJiNDUxMmZlN2FiMGJkZjAyMzQ5NGU0NGY0NzI3NTYwMjAyNGQ1N2I2ZjAxNzc1OGUwYWM0NzE)
slack workspace.
32 changes: 32 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!-- Thank you for contributing to talent-plan!
PR Title Format:
1. pkg [, pkg2, pkg3]: what's changed
2. *: what's changed
-->

### What problem does this PR solve?

- Issue number: close #xxx <!-- remove this line if no issue to close -->
- Breif description of the problem:

### 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. -->

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

Side effects

- Possible performance regression
- Increased code complexity

Related changes

- Need to update the documentation

0 comments on commit 4af66e1

Please sign in to comment.