From 4af66e1a53a8265cd818005fc731852444961bf7 Mon Sep 17 00:00:00 2001
From: Zhang Jian <zjsariel@gmail.com>
Date: Tue, 3 Mar 2020 12:44:36 +0800
Subject: [PATCH] .github: add issue&PR template (#329)

---
 .github/ISSUE_TEMPLATE/bug-report.md          | 15 +++++++++
 .github/ISSUE_TEMPLATE/feature-requirement.md | 17 ++++++++++
 .github/ISSUE_TEMPLATE/question.md            | 14 ++++++++
 .github/pull_request_template.md              | 32 +++++++++++++++++++
 4 files changed, 78 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature-requirement.md
 create mode 100644 .github/ISSUE_TEMPLATE/question.md
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
new file mode 100644
index 000000000..04c235a81
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -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?
diff --git a/.github/ISSUE_TEMPLATE/feature-requirement.md b/.github/ISSUE_TEMPLATE/feature-requirement.md
new file mode 100644
index 000000000..f6e1cd312
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature-requirement.md
@@ -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
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
new file mode 100644
index 000000000..8e5de694f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -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.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000..28f7c6490
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -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