You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@linkis.apache.org by pe...@apache.org on 2022/08/08 06:28:15 UTC
[incubator-linkis] branch master updated: Adjust ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE (#2532)
This is an automated email from the ASF dual-hosted git repository.
peacewong pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-linkis.git
The following commit(s) were added to refs/heads/master by this push:
new 3a4542040 Adjust ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE (#2532)
3a4542040 is described below
commit 3a4542040d659e13c0c9b3f9110738c0c18fb43c
Author: Casion <ca...@gmail.com>
AuthorDate: Mon Aug 8 14:28:09 2022 +0800
Adjust ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE (#2532)
---
.github/ISSUE_TEMPLATE/ask_for_help .yml | 109 +++++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/bug_report.yml | 76 ++++++++++----------
.github/ISSUE_TEMPLATE/config.yml | 2 +-
.github/ISSUE_TEMPLATE/feature_request.yml | 9 +--
.github/PULL_REQUEST_TEMPLATE.md | 78 +++++++++++++++------
5 files changed, 207 insertions(+), 67 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/ask_for_help .yml b/.github/ISSUE_TEMPLATE/ask_for_help .yml
new file mode 100644
index 000000000..01ea75f6d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/ask_for_help .yml
@@ -0,0 +1,109 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+name: ❓ Ask Questions
+title: "[Question] "
+description: Need help, or to ask questions
+labels: [Question]
+body:
+
+ - type: checkboxes
+ attributes:
+ label: Before asking
+ options:
+ - label: >
+ I have read the [How to ask for help](https://linkis.apache.org/community/how-to-ask-for-help)
+ (我已阅读[如何寻求帮助](https://linkis.apache.org/zh-CN/community/how-to-ask-for-help)指引文档).
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Your environment
+ description: Include as many relevant details about the environment you used.
+ value: |
+ <!-- Please describe the linkis version you are using and basic environment information -->
+ <!-- 请描述您使用的linkis版本和基本环境信息 -->
+ - Linkis version used: 1.1.2
+ - Environment name and version:
+ - cdh-5.14.2
+ - hdp-3.1.5
+ - hive-2.1.1
+ - spark-3.2.1
+ - scala-2.12.2
+ - jdk 1.8.0_121
+ - ....
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Describe your questions
+ description: Write down the detail info of you question
+ value: |
+ <!-- Please describe your questions -->
+ <!-- 请描述您的问题 -->
+ Q1. ...
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Eureka service list
+ description: Screenshot of the service instance displayed on the Eureka registry page
+ value: |
+ <!-- You can directly copy and paste the screenshot of the list of registered service instances displayed on the Eureka page here -->
+ <!-- 可以将Eureka页面显示的注册服务实例列表的的截图 直接复制并粘贴到这里。 粘贴后，会自动生成如下格式的url-->
+
+ eg:
+
+
+ - type: textarea
+ attributes:
+ label: Some logs info or acctch file
+ description: Some logs infomation
+ value: |
+ <!-- Please add the log in the following format, the key error log must be pasted in the code style, and the text as much as possible, the detailed log or other files can be dragged and uploaded as an attachment -->
+ <!-- 请按如下格式 添加日志，关键错误日志请贴到[````log][````]之间，尽可能贴文字，详细日志或则其它文件，可以拖拽上传作为附件 -->
+
+ linkis-xxx.log:
+ ````log
+
+ <!--日志文字贴到这里-->
+
+ ````
+ log file:
+ <!-- 拖拽上传后，会自动生成如下示例格式的附件url -->
+ [linkis-xxx.log](https://github.com/apache/incubator-linkis/files/9219529/yarn-error.log)
+
+ validations:
+ required: true
+
+
+ - type: markdown
+ attributes:
+ value: |
+ Note ❤️
+ English:
+ - Please ask questions in a standardized format, so that the community students can answer them. After asking questions, please continue to pay attention to your questions.
+ - Please pay special attention that in addition to the screenshots, you also need to paste the log text. Only the questions of the picture log will not be given priority to answer.
+ - If it is an error in the running phase, please attach the screenshot of Eureka registry service list
+ - It is recommended to ask questions in English; if there is an unclear description, you can use a mixture of Chinese and English; translate Chinese into English, and then fill in both Chinese and English into the issue
+
+ 中文:
+ - 请按格式规范提问，方便社区同学解答，提问后请后续持续关注你的问题
+ - 请特别注意除了截图，还需要把日志文字贴入，只有图片日志的问题，不会优先安排回答
+ - 如果是运行阶段的报错，请将Eureka注册中心服务列表截图附上
+ - 建议使用英文提问；如果存在描述不清晰，可以使用中英文混合；把中文翻译为英文，然后中文和英文一同填入到issue中
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index eca7753bd..49bb80b46 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -14,17 +14,17 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
-name: Bug report
+name: 🐛 Bug Report
title: "[Bug] "
-description: Problems and issues with code of Linkis
-labels: [bug, triage]
+description: Submit a bug report to help us improve
+labels: [bug, 'status: needs triage']
body:
- type: markdown
attributes:
value: |
Thank you for reporting the problem!
- Please make sure what you are reporting is a bug with reproducible steps. To ask questions
- or share ideas, pleae post on our [Discussion page](https://github.com/apache/incubator-linkis/discussions) instead.
+ Please make sure what you are reporting is a bug with reproducible steps.
+ To ask questions or share ideas, pleae post on our [Discussion page](https://github.com/apache/incubator-linkis/discussions) instead.
- type: checkboxes
attributes:
@@ -34,8 +34,7 @@ body:
whether the same issue was reported already.
options:
- label: >
- I searched the [issues](https://github.com/apache/incubator-linkis/issues) and found no similar
- issues.
+ I searched the [issues](https://github.com/apache/incubator-linkis/issues) and found no similar issues.
required: true
- type: dropdown
@@ -47,58 +46,55 @@ body:
multiple: true
options:
- "linkis-commons"
- - "linkis-cg-entrance"
- - "linkis-cg-manager"
- - "linkis-cg-engineConnplugin"
- - "linkis-cg-engineConnManager"
- - "linkis-cg-client"
+ - "linkis-computation-governance"
+ - "linkis-dist"
+ - "linkis-engineconnn-plugin"
- "linkis-extensions"
- "linkis-orchestrator"
- "linkis-public-enhancements"
- - "linkis-service-gateway"
- - "linkis-service-discovery"
- - "web"
+ - "linkis-spring-cloud-services"
+ - "linkis-web"
validations:
required: true
- type: textarea
attributes:
- label: What happened + What you expected to happen
- description: Describe 1. the bug 2. expected behavior 3. useful information (e.g., logs)
- placeholder: >
- Please provide the context in which the problem occurred and explain what happened. Further,
- To Reproduce Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '.... 4. See error
- please also explain why you think the behaviour is erroneous. It is extremely helpful if you can
- copy and paste the fragment of logs showing the exact error messages or wrong behaviour here.
-
- **NOTE**: Expected behavior A clear and concise description of what you expected to happen.Screenshots If applicable, add screenshots to help explain your problem.
+ label: Steps to reproduce
+ description: Write down the steps to reproduce the bug. You should start with a fresh installation, or your git repository linked above.
+ placeholder: |
+ 1. Step 1...
+ 2. Step 2...
+ 3. Step 3...
validations:
required: true
- type: textarea
attributes:
- label: Relevent platform
- description: The platform where you occurred this issue
- placeholder: >
- Please specify Desktop or Smartphone, Version / Dependencies / OS / Browser
+ label: Expected behavior
+ description: |
+ How did you expect your project to behave? It’s fine if you’re not sure your understanding is correct. Write down what you thought would happen.
+ placeholder: Write what you thought would happen.
validations:
required: true
+
- type: textarea
attributes:
- label: Reproduction script
- description: >
- Please provide a reproducible script. Providing a narrow reproduction (minimal / no external dependencies) will
- help us triage and address issues in the timely manner!
- placeholder: >
- Please provide a short code snippet (less than 50 lines if possible) that can be copy-pasted to
- reproduce the issue. The snippet should have **no external library dependencies**
- (i.e., use fake or mock data / environments).
+ label: Your environment
+ description: Include as many relevant details about the environment you experienced the bug in.
+ value: |
+ <!-- Please describe the linkis version you are using and basic environment information -->
+ <!-- 请描述您使用的linkis版本和基本环境信息 -->
+ - Linkis version used: 1.1.2
+ - Environment name and version:
+ - cdh-5.14.2
+ - hdp-3.1.5
+ - hive-2.1.1
+ - spark-3.2.1
+ - scala-2.12.2
+ - jdk 1.8.0_121
+ - ....
- **NOTE**: If the code snippet cannot be run by itself, the issue will be marked as "needs-repro-script"
- until the repro instruction is updated.
- validations:
- required: true
- type: textarea
attributes:
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index a1aef2b40..89bf2bb8c 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -17,7 +17,7 @@
blank_issues_enabled: fasle
contact_links:
- - name: Ask a question or get support
+ - name: Get Support
url: https://github.com/apache/incubator-linkis/discussions
about: Ask a question or request support for using Linkis
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
index 3d092f5cc..f76d3807e 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -15,10 +15,11 @@
# limitations under the License.
#
-name: Linkis feature request
-description: Suggest an idea for Linkis project
-title: "[Feature] "
-labels: [enhancement]
+
+name: 💅 Feature Request
+description: Submit a detailed feature request
+title: "[Feature][Module Name] Feature title "
+labels: [feature, 'status: needs triage']
body:
- type: markdown
attributes:
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 8b191bb01..f38af2d39 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,28 +1,62 @@
+<!--
+Thank you for sending the PR! We appreciate you spending the time to work on these changes.
+You can learn more about contributing to Apache Linkis here: https://linkis.apache.org/community/how-to-contribute
+Happy contributing!
+-->
+
### What is the purpose of the change
-(For example: EngineConn-Core defines the the abstractions and interfaces of the EngineConn core functions.
-The Engine Service in Linkis 0.x is refactored, EngineConn will handle the engine connection and session management.
-Related issues: #590. )
+
+EngineConn-Core defines the the abstractions and interfaces of the EngineConn core functions.
+The Engine Service in Linkis 0.x is refactored, EngineConn will handle the engine connection
+and session management.
+
+### Related issues/PRs
+
+Related issues: #590
+Related pr:#591
+
### Brief change log
-(for example:)
+
- Define the core abstraction and interfaces of the EngineConn Factory;
- Define the core abstraction and interfaces of Executor Manager.
-### Verifying this change
-(Please pick either of the following options)
-This change is a trivial rework / code cleanup without any test coverage.
-(or)
-This change is already covered by existing tests, such as (please describe tests).
-(or)
-This change added tests and can be verified as follows:
-(example:)
-- Added tests for submit and execute all kinds of jobs to go through and verify the lifecycles of different EngineConns.
-
-### Does this pull request potentially affect one of the following parts:
-- Dependencies (does it add or upgrade a dependency): (yes / no)
-- Anything that affects deployment: (yes / no / don't know)
-- The MGS(Microservice Governance Services), i.e., Spring Cloud Gateway, OpenFeign, Eureka.: (yes / no)
-
-### Documentation
-- Does this pull request introduce a new feature? (yes / no)
-- If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
\ No newline at end of file
+
+### Checklist
+
+- [x] I have read the [Contributing Guidelines on pull requests](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#pull-requests).
+- [ ] I have explained the need for this PR and the problem it solves
+- [ ] I have explained the changes or the new features added to this PR
+- [ ] I have added tests corresponding to this change
+- [ ] I have updated the documentation to reflect this change
+- [ ] I have verified that this change is backward compatible (If not, please discuss on the [Linkis mailing list](https://linkis.apache.org/community/how-to-subscribe) first)
+- [ ] **If this is a code change**: I have written unit tests to fully verify the new behavior.
+
+
+
+<!--
+
+Note
+
+1. Mark the PR title as `[WIP] title` until it's ready to be reviewed.
+ 如果PR还未准备好被review，请在标题上添加[WIP]标识(WIP work in progress)
+
+2. Always add/update tests for any changes unless you have a good reason.
+ 除非您有充分的理由，否则任何修改都需要添加/更新测试
+
+3. Always update the documentation to reflect the changes made in the PR.
+ 始终更新文档以反映 PR 中所做的更改
+
+4. After the PR is submitted, please pay attention to the execution result of git action check.
+ If there is any failure, please adjust it in time
+ PR提交后，请关注git action check 执行结果，关键的check失败时，请及时修正
+
+5. Before the pr is merged, if the commit is missing, you can continue to commit the code
+ 在未合并前，如果提交有遗漏，您可以继续提交代码
+
+6. After you submit PR, you can add assistant WeChat, the WeChat QR code is
+ https://user-images.githubusercontent.com/7869972/176336986-d6b9be8f-d1d3-45f1-aa45-8e6adf5dd244.png
+ 您提交pr后，可以添加助手微信，微信二维码为
+ https://user-images.githubusercontent.com/7869972/176336986-d6b9be8f-d1d3-45f1-aa45-8e6adf5dd244.png
+
+-->
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@linkis.apache.org
For additional commands, e-mail: commits-help@linkis.apache.org