You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by wa...@apache.org on 2022/06/07 07:48:39 UTC
[incubator-devlake] branch main updated: update gitlab issue template
This is an automated email from the ASF dual-hosted git repository.
warren pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git
The following commit(s) were added to refs/heads/main by this push:
new f5c06f53 update gitlab issue template
f5c06f53 is described below
commit f5c06f53ca8fc9d22303db9cc1e5b708fd8aa778
Author: Mr.An <42...@users.noreply.github.com>
AuthorDate: Fri Jun 3 19:35:38 2022 +0800
update gitlab issue template
---
.github/ISSUE_TEMPLATE/bug-report.yml | 134 +++++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/bug_report.md | 27 ------
.github/ISSUE_TEMPLATE/config.yml | 21 +++++
.github/ISSUE_TEMPLATE/feature-request.yml | 81 +++++++++++++++++
4 files changed, 236 insertions(+), 27 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
new file mode 100644
index 00000000..7c202105
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,134 @@
+#
+# 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] [Module Name] Bug title "
+description: Problems and issues with code of Apache DevLake
+labels: [ "bug", "Waiting for reply" ]
+body:
+ - type: markdown
+ attributes:
+ value: >
+ Please make sure what you are reporting is indeed a bug with reproducible steps, if you want to ask questions
+ or share ideas, you can head to our
+ [Discussions](https://github.com/apache/incubator-devlake/discussions) tab, you can also
+ [join our slack](https://join.slack.com/t/devlake-io/shared_invite/zt-18uayb6ut-cHOjiYcBwERQ8VVPZ9cQQw)
+ and send your question to channel `#questions`
+
+ For better global communication, Please write in English.
+
+ If you feel the description in English is not clear, then you can append description in Chinese, thanks!
+
+ - type: checkboxes
+ attributes:
+ label: Search before asking
+ description: >
+ Please make sure to search in the [issues](https://github.com/apache/incubator-devlake/issues?q=is%3Aissue)
+ first to see whether the same issue was reported already.
+ options:
+ - label: >
+ I had searched in the [issues](https://github.com/apache/incubator-devlake/issues?q=is%3Aissue) and found
+ no similar issues.
+ required: true
+
+ - 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.
+
+ **NOTE**: please copy and paste texts instead of taking screenshots of them for easy future search.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: How to reproduce
+ description: >
+ What should we do to reproduce the problem? If you are not able to provide a reproducible case,
+ please open a [Discussion](https://github.com/apache/incubator-devlake/discussions) instead.
+ 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: Anything else
+ description: Anything else we need to know?
+ placeholder: >
+ How often does this problem occur? (Once? Every time? Only when certain conditions are met?)
+ Any relevant logs to include? Put them here inside fenced
+ ``` ``` blocks or inside a collapsable details tag if it's too long:
+ <details><summary>x.log</summary> lots of stuff </details>
+
+ - type: dropdown
+ id: version
+ attributes:
+ label: Version
+ description: >
+ Which version of Apache DevLake are you running? We only accept bugs report from the LTS projects.
+ options:
+ - main
+ - 0.10.1
+ - 0.10.0
+ - 0.9.3
+ - 0.9.2
+ - 0.9.1
+ - 0.9.0
+ 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 fix.
+ Apache DevLake is a totally community-driven project and we love to bring new contributors in.
+ options:
+ - label: Yes I am willing to submit a PR!
+
+ - type: checkboxes
+ attributes:
+ label: Code of Conduct
+ description: |
+ The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it.
+ 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/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 3b604163..00000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,27 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: type/bug
-assignees: ''
-
----
-
-## Describe the bug
-A clear and concise description of what the bug is.
-
-## To Reproduce
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-## Expected behavior
-A clear and concise description of what you expected to happen.
-
-## Screenshots
-If applicable, add screenshots to help explain your problem.
-
-## Additional context
-Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 3ba13e0c..134b1207 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1 +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: Ask a question or get support
+ url: https://github.com/apache/incubator-devlake/discussions/
+ about: Ask a question or request support for using Apache DevLake
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
new file mode 100644
index 00000000..6fce306f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,81 @@
+#
+# 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
+description: Suggest an idea for this project
+title: "[Feature][Module Name] Feature title"
+labels: [ "new feature", "Waiting for reply" ]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ For better global communication, Please write in English.
+
+ If you feel the description in English is not clear, then you can append description in Chinese, thanks!
+
+ - type: checkboxes
+ attributes:
+ label: Search before asking
+ description: >
+ Please make sure to search in the [issues](https://github.com/apache/incubator-devlake/issues?q=is%3Aissue) first
+ to see whether the same feature was requested already.
+ options:
+ - label: >
+ I had searched in the [issues](https://github.com/apache/incubator-devlake/issues?q=is%3Aissue) and found no
+ similar feature requirement.
+ required: true
+
+ - 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: >
+ Rather than telling us how you might implement this feature, try to take a
+ step back and describe what you are trying to achieve.
+
+ - type: textarea
+ attributes:
+ label: Related issues
+ description: Is there currently another issue associated with this?
+
+ - type: checkboxes
+ attributes:
+ label: Are you willing to submit a 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.
+ Apache DevLake is a totally community-driven project and we love to bring new contributors in.
+ options:
+ - label: Yes I am willing to submit a PR!
+
+ - type: checkboxes
+ attributes:
+ label: Code of Conduct
+ description: |
+ The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it.
+ 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!"