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 2022/06/26 10:22:17 UTC
[inlong-website] 01/01: [INLONG-457][CI] Update the github template for keep same tihe main repo
This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch fix-457
in repository https://gitbox.apache.org/repos/asf/inlong-website.git
commit ff9e44e3f75065fa41155a99b5dc8c91a4c6726c
Author: dockerzhang <do...@apache.org>
AuthorDate: Sun Jun 26 18:22:08 2022 +0800
[INLONG-457][CI] Update the github template for keep same tihe main repo
---
.github/ISSUE_TEMPLATE/bug-report.md | 28 ---------
.github/ISSUE_TEMPLATE/bug-report.yml | 91 ++++++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/feature-request.md | 26 ---------
.github/ISSUE_TEMPLATE/feature-request.yml | 62 ++++++++++++++++++++
.github/ISSUE_TEMPLATE/improve-request.yml | 55 ++++++++++++++++++
.github/ISSUE_TEMPLATE/question.md | 12 ----
.github/ISSUE_TEMPLATE/question.yml | 22 ++++++++
.github/ISSUE_TEMPLATE/umbrella.yml | 85 ++++++++++++++++++++++++++++
.github/PULL_REQUEST_TEMPLATE.md | 9 ++-
9 files changed, 322 insertions(+), 68 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
deleted file mode 100644
index db45fefc7..000000000
--- a/.github/ISSUE_TEMPLATE/bug-report.md
+++ /dev/null
@@ -1,28 +0,0 @@
----
-name: "\U0001F41B Bug report"
-about: Create a report to help us improve
-
----
-
-<!--
-Thanks for contributing to InLong!
-Please explain your issue precisely, and if possible provide a reproducer
-snippet (this helps resolve issues much quicker).
--->
-
-#### Expected behavior
-
-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
-
-
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
new file mode 100644
index 000000000..0e3ffb450
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,91 @@
+#
+# 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: '🐛 Bug Report'
+title: '[Bug]'
+description: Problems and issues with code of Apache InLong
+labels: [ 'bug' ]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thank you for finding the time to report the problem! We really appreciate the community efforts to improve InLong.
+
+ Please explain your issue precisely, and if possible provide a reproducer snippet (this helps resolve issues much quicker).
+
+ - type: textarea
+ attributes:
+ label: What happened
+ description: Describe what happened.
+ placeholder: >
+ Please provide the context in which the problem occurred and explain what happened.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: What you expected to happen
+ description: What do you think went wrong?
+ placeholder: >
+ Please explain why you think the behaviour is erroneous. It is extremely helpful if you copy and paste
+ the fragment of logs showing the exact error messages or wrong behaviour and screenshots for
+ UI problems. You can include files by dragging and dropping them here.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: How to reproduce
+ description: >
+ What should we do to reproduce the problem?
+ placeholder: >
+ Please make sure you provide a reproducible step-by-step case of how to reproduce the problem
+ as minimally and precisely as possible. Keep in mind we do not have access to your deployment.
+ Remember that non-reproducible issues will be closed! Opening a discussion is recommended as a
+ first step.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Environment
+ description: >
+ In which environment did you find this problem?
+ placeholder: >
+ MacOs Big Sur Version 11.3.1
+
+ - type: checkboxes
+ attributes:
+ label: Are you willing to submit PR?
+ description: >
+ This is absolutely not required, but we are happy to guide you in the contribution process
+ especially if you already have a good understanding of how to implement the fix.
+ options:
+ - label: Yes, I am willing to submit a PR!
+
+ - type: checkboxes
+ attributes:
+ label: Code of Conduct
+ options:
+ - label: >
+ I agree to follow this project's
+ [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
+ required: true
+
+ - type: markdown
+ attributes:
+ value: "Thanks for completing our form!"
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
deleted file mode 100644
index 29b63ad1d..000000000
--- a/.github/ISSUE_TEMPLATE/feature-request.md
+++ /dev/null
@@ -1,26 +0,0 @@
----
-name: "\U0001F389 Feature request"
-about: Suggest an idea for this project
-
----
-
-<!--
-Thanks for contributing InLong!
-Please explain your use case precisely, and if possible provide an example
-snippet.
--->
-
-**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.
-
-
-
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
new file mode 100644
index 000000000..aabd874ad
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,62 @@
+#
+# 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: '🎉 Feature Request'
+title: "[Feature]"
+description: Suggest an idea for Apache InLong
+labels: [ "feature" ]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thank you for finding the time to propose new feature!
+
+ We really appreciate the community efforts to improve InLong.
+
+ - type: textarea
+ attributes:
+ label: Description
+ description: A short description of your feature.
+
+ - type: textarea
+ attributes:
+ label: Use case
+ description: What do you want to happen?
+ placeholder: >
+ A clear and concise description of what you want to happen.
+
+ - type: checkboxes
+ attributes:
+ label: Are you willing to submit PR?
+ description: >
+ This is absolutely not required, but we are happy to guide you in the contribution process
+ especially if you already have a good understanding of how to implement the feature.
+ options:
+ - label: Yes, I am willing to submit a PR!
+
+ - type: checkboxes
+ attributes:
+ label: Code of Conduct
+ options:
+ - label: >
+ I agree to follow this project's
+ [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
+ required: true
+
+ - type: markdown
+ attributes:
+ value: "Thanks for completing our form!"
diff --git a/.github/ISSUE_TEMPLATE/improve-request.yml b/.github/ISSUE_TEMPLATE/improve-request.yml
new file mode 100644
index 000000000..6efed37df
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/improve-request.yml
@@ -0,0 +1,55 @@
+#
+# 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: '👍 Improve Request'
+title: "[Improve]"
+description: Suggest an idea for Apache InLong
+labels: [ "improve" ]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thank you for finding the time to propose improvement!
+
+ We really appreciate the community efforts to improve InLong.
+
+ - type: textarea
+ attributes:
+ label: Description
+ description: A short description of your improvement suggestion.
+
+ - type: checkboxes
+ attributes:
+ label: Are you willing to submit PR?
+ description: >
+ This is absolutely not required, but we are happy to guide you in the contribution process
+ especially if you already have a good understanding of how to implement the improvement.
+ options:
+ - label: Yes, I am willing to submit a PR!
+
+ - type: checkboxes
+ attributes:
+ label: Code of Conduct
+ options:
+ - label: >
+ I agree to follow this project's
+ [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
+ required: true
+
+ - type: markdown
+ attributes:
+ value: "Thanks for completing our form!"
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
deleted file mode 100644
index d7aa21eb8..000000000
--- a/.github/ISSUE_TEMPLATE/question.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-name: "❓ Question"
-about: Ask a question about InLong
-
----
-
-<!--
-Welcome to InLong community!
-Please try to describe your question in English and start the title with
-[question].
--->
-
diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml
new file mode 100644
index 000000000..e9d40c16a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.yml
@@ -0,0 +1,22 @@
+#
+# 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.
+#
+
+blank_issues_enabled: false
+contact_links:
+- name: '❓ Question'
+ url: https://github.com/apache/inlong/discussions
+ about: Ask a question or request support for using Apache InLong
diff --git a/.github/ISSUE_TEMPLATE/umbrella.yml b/.github/ISSUE_TEMPLATE/umbrella.yml
new file mode 100644
index 000000000..0d5c915ad
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/umbrella.yml
@@ -0,0 +1,85 @@
+#
+# 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: '☂ Umbrella'
+title: "[Umbrella] "
+description: An umbrella issue with multiple subtasks
+labels: [ "umbrella" ]
+body:
+ - type: textarea
+ attributes:
+ label: Describe the proposal
+ placeholder: >
+ Please describe the content of the proposal clearly.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Task list
+ description: >
+ For more details, please refer to [github docs](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists).
+ placeholder: >
+ Please create subtasks with the pre-create issues here and @ the assignees if you know any of them. A simple example is as follows:
+ - [ ] #1
+ - [ ] #2 @user1
+ - [ ] #3
+ - [ ] #4 @user2
+ - [ ] #5
+ validations:
+ required: true
+
+ - type: dropdown
+ attributes:
+ label: InLong Component
+ description: |
+ Which components of Apache InLong are relevant to your proposal?
+ multiple: true
+ options:
+ - 'InLong Manager'
+ - 'InLong Dashboard'
+ - 'InLong Agent'
+ - 'InLong DataProxy'
+ - 'InLong SDK'
+ - 'InLong TubeMQ'
+ - 'InLong Sort'
+ - 'InLong Audit'
+ - 'Other for not specified component'
+ validations:
+ required: true
+
+ - type: checkboxes
+ attributes:
+ label: Are you willing to submit PR?
+ description: >
+ This is absolutely not required, but we are happy to guide you in the contribution process
+ especially if you already have a good understanding of how to implement the improvement.
+ options:
+ - label: Yes, I am willing to submit a PR!
+
+ - type: checkboxes
+ attributes:
+ label: Code of Conduct
+ options:
+ - label: >
+ I agree to follow this project's
+ [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
+ required: true
+
+ - type: markdown
+ attributes:
+ value: "Thanks for completing our form!"
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 9c42ed919..5737eefe1 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,6 +1,11 @@
-Fixes #<xyz>
+### Prepare a Pull Request
+*(Change the title refer to the following example)*
-where *XYZ* should be replaced by the actual issue number.
+- Title Example: [INLONG-XYZ][Component] Title of the pull request
+
+*(The following *XYZ* should be replaced by the actual [GitHub Issue](https://github.com/apache/inlong/issues) number)*
+
+- Fixes #XYZ
### Motivation