docs: add issue template and pull request template (#1)

archerny · archerny · commit 09d55e7b6504 · 2022-06-14T23:36:48.000+08:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+labels: bug
+---
+
+**Describe this problem**
+
+<!---
+What this problem is and what happened.
+-->
+
+**Steps to reproduce**
+
+<!---
+How to reproduce this problem.
+-->
+
+**Expected behavior**
+
+<!---
+What is expected.
+-->
+
+**Additional Information**
+
+<!---
+If possible, please attach other context you think may relate to this problem. Like *runtime environment*, *modified config*, *error log* etc.
+-->
+
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,25 @@
+---
+name: Feature request
+about: Suggest an idea for CeresDB
+labels: enhancement
+---
+
+**Description**
+
+<!---
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 
+(This section helps Arrow developers understand the context and *why* for this feature, in addition to  the *what*)
+-->
+
+**Proposal**
+
+<!---
+Maybe you have considered some ideas or solutions about this feature.
+-->
+
+**Additional context**
+
+<!---
+Add any other context or screenshots about the feature request here.
+-->
+
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,24 @@
+---
+name: Question
+about: Ask question about CeresDB
+labels: question
+---
+
+**Which part is this question about**
+
+<!---
+Is it code base, usage, deployment, documentation or some other part?
+-->
+
+**Describe your question**
+
+<!---
+A clear and concise description of what the question is.
+-->
+
+**Additional context**
+
+<!---
+Add any other context about the problem here.
+-->
+
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,31 @@
+# Which issue does this PR close?
+
+Closes #
+
+# Rationale for this change
+ 
+<!---
+ Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
+ Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
+-->
+
+# What changes are included in this PR?
+
+<!---
+There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR to help reviewer understand the structure.
+-->
+
+# Are there any user-facing changes?
+
+<!---
+Please mention if:
+
+- there are user-facing changes that needs to update the documentation or configuration.
+- this is a breaking change to public APIs
+-->
+
+# How does this change test
+
+<!-- 
+Please describe how you test this change (like by unit test case, integration test or some other ways) if this change has touched the code.
+-->
