You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by do...@apache.org on 2021/07/28 11:57:23 UTC

[incubator-inlong] branch master updated: [INLONG-1264][Platform] update the issue template for InLong (#1399)

This is an automated email from the ASF dual-hosted git repository.

dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong.git


The following commit(s) were added to refs/heads/master by this push:
     new 35796f5  [INLONG-1264][Platform] update the issue template for InLong (#1399)
35796f5 is described below

commit 35796f54d954c99127026961204d0f2a25823463
Author: dockerzhang <do...@apache.org>
AuthorDate: Wed Jul 28 19:57:16 2021 +0800

    [INLONG-1264][Platform] update the issue template for InLong (#1399)
    
    Co-authored-by: dockerzhang <do...@tencent.com>
---
 .github/ISSUE_TEMPLATE/bug-report.md      | 18 ++++++++++++++----
 .github/ISSUE_TEMPLATE/feature-request.md | 16 ++++++++++++----
 .github/ISSUE_TEMPLATE/question.md        |  4 ++--
 .github/PULL_REQUEST_TEMPLATE.md          |  8 ++++++--
 4 files changed, 34 insertions(+), 12 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
index 2da5bfa..db45fef 100644
--- a/.github/ISSUE_TEMPLATE/bug-report.md
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -5,14 +5,24 @@ about: Create a report to help us improve
 ---
 
 <!--
-Thanks for contributing to TubeMQ!
+Thanks for contributing to InLong!
 Please explain your issue precisely, and if possible provide a reproducer
 snippet (this helps resolve issues much quicker).
 -->
 
-**Problem description**
+#### Expected behavior
 
-**(optional) Reproducer snippet**
+Tell us what should happen
+
+#### Actual behavior
+
+Tell us what happens instead
+
+#### Steps to reproduce
+
+How can we reproduce the issue
+
+#### System configuration
+**InLong version**: x.y
 
-**(optional) Suggestions for an improvement**
 
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
index 8273019..29b63ad 100644
--- a/.github/ISSUE_TEMPLATE/feature-request.md
+++ b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -5,14 +5,22 @@ about: Suggest an idea for this project
 ---
 
 <!--
-Thanks for contributing TubeMQ!
+Thanks for contributing InLong!
 Please explain your use case precisely, and if possible provide an example
 snippet.
 -->
 
-**Motivation**
+**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 the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
 
-**(optional) Design**
 
-**(optional) Example snippet**
 
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
index 9620897..d7aa21e 100644
--- a/.github/ISSUE_TEMPLATE/question.md
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -1,11 +1,11 @@
 ---
 name: "❓ Question"
-about: Ask a question about TubeMQ
+about: Ask a question about InLong
 
 ---
 
 <!--
-Welcome to TubeMQ community!
+Welcome to InLong community!
 Please try to describe your question in English and start the title with
 [question].
 -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index a91b541..5eefb9a 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,9 @@
-Fixes Jira Issue ID:
-https://issues.apache.org/jira/projects/INLONG/issues/replace_by_issue_id
+
+### Title Name: [INLONG-XYZ][component] Title of the pull request
+
+where *XYZ* should be replaced by the actual issue number.
+
+Fixes #<xyz>
 
 ### Motivation