This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 700cee1161 ci: Add issue template and pr template for opendal (#4884)
700cee1161 is described below
commit 700cee11616fdd120137e049037a39fd69769892
Author: Xuanwo <[email protected]>
AuthorDate: Fri Jul 12 14:15:56 2024 +0800
ci: Add issue template and pr template for opendal (#4884)
Signed-off-by: Xuanwo <[email protected]>
---
.github/ISSUE_TEMPLATE/1-bug-report.yml | 72 ++++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/2-feature-request.yml | 60 +++++++++++++++++++++++
.github/ISSUE_TEMPLATE/3-new-release.md | 50 +++++++++++++++++++
.github/ISSUE_TEMPLATE/config.yml | 25 ++++++++++
.github/pull_request_template.md | 31 ++++++++++++
5 files changed, 238 insertions(+)
diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml
b/.github/ISSUE_TEMPLATE/1-bug-report.yml
new file mode 100644
index 0000000000..f6668ad38c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml
@@ -0,0 +1,72 @@
+# 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
+description: Create a report to help us improve
+title: "bug: "
+labels: ["bug"]
+body:
+ - type: markdown
+ attributes:
+ value: "Thank you for taking the time to report a bug. Please provide as
much information as possible to help us understand and resolve the issue."
+
+ - type: textarea
+ id: describe-bug
+ attributes:
+ label: Describe the bug
+ description: "A clear and concise description of what the bug is."
+ placeholder: "Describe the bug..."
+ validations:
+ required: true
+
+ - type: textarea
+ id: steps-to-reproduce
+ attributes:
+ label: Steps to Reproduce
+ description: "Steps to reproduce the behavior:"
+ validations:
+ required: true
+
+ - type: textarea
+ id: expected-behavior
+ attributes:
+ label: Expected Behavior
+ description: "A clear and concise description of what you expected to
happen."
+ placeholder: "Explain what you expected to happen..."
+ validations:
+ required: true
+
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Additional Context
+ description: "Add any other context about the problem here."
+ placeholder: "Additional details..."
+ validations:
+ required: false
+
+ - type: markdown
+ attributes:
+ value: "Please make sure to include any relevant information such as
screenshots, logs, or code snippets that may help in diagnosing the issue."
+
+ - type: checkboxes
+ id: willing-to-submit-pr
+ attributes:
+ label: "Are you willing to submit a PR to fix this bug?"
+ description: "Let us know if you are willing to contribute a fix by
submitting a Pull Request."
+ options:
+ - label: "Yes, I would like to submit a PR."
diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml
b/.github/ISSUE_TEMPLATE/2-feature-request.yml
new file mode 100644
index 0000000000..a31b94f007
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2-feature-request.yml
@@ -0,0 +1,60 @@
+# 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: "new feature: "
+labels: ["enhancement"]
+body:
+ - type: markdown
+ attributes:
+ value: "Thank you for suggesting a new feature. Please fill out the
details below to help us understand your idea better."
+
+ - type: textarea
+ id: feature-description
+ attributes:
+ label: Feature Description
+ description: "A detailed description of the feature you would like to
see."
+ placeholder: "Describe the feature you'd like..."
+ validations:
+ required: true
+
+ - type: textarea
+ id: problem-solution
+ attributes:
+ label: Problem and Solution
+ description: "Describe the problem that this feature would solve.
Explain how you envision it working."
+ placeholder: "What problem does this feature solve? How do you envision
it working?"
+ validations:
+ required: true
+
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Additional Context
+ description: "Add any other context or screenshots about the feature
request here."
+ placeholder: "Add any other context or screenshots about the feature
request here."
+ validations:
+ required: false
+
+ - type: checkboxes
+ id: willing-to-contribute
+ attributes:
+ label: "Are you willing to contribute to the development of this
feature?"
+ description: "Let us know if you are willing to help by contributing
code or other resources."
+ options:
+ - label: "Yes, I am willing to contribute to the development of this
feature."
diff --git a/.github/ISSUE_TEMPLATE/3-new-release.md
b/.github/ISSUE_TEMPLATE/3-new-release.md
new file mode 100644
index 0000000000..d82cc04f24
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/3-new-release.md
@@ -0,0 +1,50 @@
+---
+name: New Release
+about: Use this template for start making a new release
+title: "Tracking issues of OpenDAL ${opendal_version} Release"
+---
+
+This issue is used to track tasks of the opendal ${opendal_version} release.
+
+## Tasks
+
+### Blockers
+
+<!-- Blockers are the tasks that must be completed before the release. -->
+
+### Build Release
+
+#### Relelase List
+
+<!-- Generate release list by `./scripts/version.py`, please adapt with the
actual needs. -->
+
+#### GitHub Side
+
+- [ ] Bump version in project
+ - [ ] rust
+ - [ ] cpp
+ - [ ] haskell
+ - [ ] java
+ - [ ] nodejs
+- [ ] Update docs
+- [ ] Generate dependencies list
+- [ ] Push release candidate tag to GitHub
+
+#### ASF Side
+
+- [ ] Create an ASF Release
+- [ ] Upload artifacts to the SVN dist repo
+- [ ] Close the Nexus staging repo
+
+### Voting
+
+- [ ] Start VOTE at opendal community
+
+### Official Release
+
+- [ ] Push the release git tag
+- [ ] Publish artifacts to SVN RELEASE branch
+- [ ] Release Maven artifacts
+- [ ] Send the announcement
+
+For details of each step, please refer to:
https://opendal.apache.org/community/release/
diff --git a/.github/ISSUE_TEMPLATE/config.yml
b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000000..05c7aa01c9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,25 @@
+# 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: true
+contact_links:
+ - name: Question
+ url: https://github.com/apache/opendal/discussions/new?category=q-a
+ about: Ask questions about opendal usage and development.
+ - name: Discord
+ url: https://opendal.apache.org/discord
+ about: Join discord for real-time discussions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000000..5519c2248e
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,31 @@
+# Which issue does this PR close?
+
+<!--
+We generally require a GitHub issue to be filed for all bug fixes and
enhancements. You can link an issue to this PR using the GitHub syntax. For
example `Closes #123` indicates that this PR will close issue #123.
+-->
+
+Closes #.
+
+# Rationale for this change
+
+<!--
+Why are you proposing this change? If this is already explained clearly in the
issue then this section is not needed.
+Explaining clearly why changes are proposed helps reviewers understand your
changes and offer better suggestions for fixes.
+-->
+
+# What changes are included in this PR?
+
+<!--
+There is no need to duplicate the description in the issue here but it is
sometimes worth providing a summary of the individual changes in this PR.
+-->
+
+# Are there any user-facing changes?
+
+
+<!--
+If there are user-facing changes then we may require documentation to be
updated before approving the PR.
+-->
+
+<!---
+If there are any breaking changes to public APIs, please add the
`breaking-changes` label.
+-->
