You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by yu...@apache.org on 2022/10/26 07:19:24 UTC
[incubator-devlake-website] branch main updated: docs: add issue templates (#290)
This is an automated email from the ASF dual-hosted git repository.
yumeng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new 7319dc4ce docs: add issue templates (#290)
7319dc4ce is described below
commit 7319dc4ced5e5d76de45c761e61214b44b424ebe
Author: Louis.z <lo...@gmail.com>
AuthorDate: Wed Oct 26 15:19:20 2022 +0800
docs: add issue templates (#290)
Co-authored-by: Startrekzky <ka...@merico.dev>
---
.github/ISSUE_TEMPLATE/bug-report.yml | 103 +++++++++++++++++++++++
.github/ISSUE_TEMPLATE/config.yml | 18 ++++
.github/ISSUE_TEMPLATE/documentation.md | 20 +++++
.github/ISSUE_TEMPLATE/question.md | 17 ++++
.github/{workflows => }/pull_request_template.md | 5 +-
5 files changed, 159 insertions(+), 4 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
new file mode 100644
index 000000000..bb3abfff4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,103 @@
+#
+# 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][Doc Name] Bug title "
+description: Problems with the docs of Apache DevLake Website
+labels: ["type/bug"]
+body:
+ - type: checkboxes
+ attributes:
+ label: Search before asking
+ description: >
+ Please make sure to search in the [issues](https://github.com/apache/incubator-devlake-website/issues?q=is%3Aissue)
+ to check if this bug already exists.
+ 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 add the doc link and screenshot(s)
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: What do you expect to happen
+ description: Describe the change.
+ placeholder: >
+ Add the updated version of doc here.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Anything else
+ description: Anything else we need to know?
+ placeholder: >
+
+
+ - type: dropdown
+ id: version
+ attributes:
+ label: Version
+ description: >
+ The doc version.
+ options:
+ - main
+ - v0.14.2
+ - v0.14.1
+ - v0.14.0
+ - v0.13.0
+ - v0.12.0
+ - v0.11.0
+ - v0.10.1
+ - v0.10.0
+ - v0.9.3
+ - v0.9.2
+ - v0.9.1
+ - v0.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: |
+ Please follow the Code of Conduct of Apache DevLake community.
+ options:
+ - label: >
+ I agree to follow this project's
+ [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
+ required: true
+
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..78a032fd9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,18 @@
+#
+# 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
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
new file mode 100644
index 000000000..c085193b6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -0,0 +1,20 @@
+---
+name: Documentation Issue
+about: Help improve our documentation
+title: '[Doc][Module Name] Documentation title'
+labels: type/docs
+assignees: ''
+
+---
+
+## Documentation Scope
+Briefly explain what the documentation is referencing, eg. Homepage, Getting Started, User Manuals, etc.
+
+## Describe the Change
+A clear and concise description of what will be added/updated in the documentation
+
+## Screenshots
+If applicable, add screenshots to help explain your thoughts.
+
+## Additional context
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
new file mode 100644
index 000000000..c140f39dc
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,17 @@
+---
+name: Question
+about: Ask a question
+title: '[Question][Doc Name] Question title'
+labels: type/question
+assignees: ''
+
+---
+
+## Question
+Ask a question here.
+
+## Screenshots
+If applicable, add screenshots to help explain.
+
+## Additional context
+Add any other context here.
diff --git a/.github/workflows/pull_request_template.md b/.github/pull_request_template.md
similarity index 76%
rename from .github/workflows/pull_request_template.md
rename to .github/pull_request_template.md
index d9d09e942..e4cd48068 100644
--- a/.github/workflows/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -8,10 +8,7 @@
# Summary
<!--
-Thanks for submitting a pull request!
-
-We appreciate you spending the time to work on these changes.
-Please fill out as many sections below as possible.
+Thanks for submitting a PR! We appreciate you spending the time to work on these changes. Please fill out as many sections below as possible.
-->
### Does this close any open issues?