This is an automated email from the ASF dual-hosted git repository.
gangwu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/parquet-format.git
The following commit(s) were added to refs/heads/master by this push:
new abb92e6 GH-443: Add GitHub issue template (#444)
abb92e6 is described below
commit abb92e61e9756016c08401fef729d2ace187d184
Author: Gang Wu <[email protected]>
AuthorDate: Mon Jul 8 22:58:45 2024 +0800
GH-443: Add GitHub issue template (#444)
---
.github/ISSUE_TEMPLATE/bug_report.yaml | 29 ++++++++++++++++
.github/ISSUE_TEMPLATE/config.yaml | 18 ++++++++++
.github/ISSUE_TEMPLATE/feature_request.yaml | 32 ++++++++++++++++++
.github/ISSUE_TEMPLATE/usage_question.yaml | 52 +++++++++++++++++++++++++++++
.github/PULL_REQUEST_TEMPLATE.md | 37 +++++++++++---------
5 files changed, 152 insertions(+), 16 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml
b/.github/ISSUE_TEMPLATE/bug_report.yaml
new file mode 100644
index 0000000..af2272b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -0,0 +1,29 @@
+# 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: File a bug report
+labels: ["Type: bug"]
+assignees: []
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Describe the bug, including details regarding any error messages,
version, and platform.
+ description: Please include what you expected.
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yaml
b/.github/ISSUE_TEMPLATE/config.yaml
new file mode 100644
index 0000000..8085d31
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yaml
@@ -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/feature_request.yaml
b/.github/ISSUE_TEMPLATE/feature_request.yaml
new file mode 100644
index 0000000..5912e69
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yaml
@@ -0,0 +1,32 @@
+# 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: Enhancement Request
+description: Request an enhancement to the project
+labels: ["Type: enhancement"]
+assignees: []
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to share your feedback on ways Apache
Parquet can be improved!
+ - type: textarea
+ id: description
+ attributes:
+ label: Describe the enhancement requested
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/usage_question.yaml
b/.github/ISSUE_TEMPLATE/usage_question.yaml
new file mode 100644
index 0000000..29db6c3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/usage_question.yaml
@@ -0,0 +1,52 @@
+# 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: Question
+description: Ask a question
+labels: ["Type: question"]
+assignees: []
+body:
+ - type: markdown
+ attributes:
+ value: >
+ While we enable issues as a mechanism for new contributors and
passers-by who
+ are unfamiliar with Apache Software Foundation projects to ask
questions and
+ interact with the project, we encourage users to ask such questions on
public
+ mailing lists:
+
+ * Development discussions: [email protected] (first subscribe by
sending an
+ e-mail to [email protected]).
+
+ * User discussions: [email protected] (first subscribe by
sending an e-mail
+ to [email protected]).
+
+ * Mailing list archives: https://parquet.apache.org/community/
+
+
+ Do not be surprised by responses to issues raised here directing you
to those
+ mailing lists, or to report a bug or feature request here.
+
+
+ Thank you!
+ - type: textarea
+ id: description
+ attributes:
+ label: >
+ Describe the usage question you have. Please include as many useful
details as
+ possible.
+ validations:
+ required: true
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 9cd5f8e..023dc81 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,22 +1,27 @@
-Make sure you have checked _all_ steps below.
+<!--
+Thanks for opening a pull request!
-### Jira
+If you're new to Parquet-Format, information on how to contribute can be found
here: https://parquet.apache.org/docs/contribution-guidelines/contributing
-- [ ] My PR addresses the following [Parquet
Jira](https://issues.apache.org/jira/browse/PARQUET/) issues and references
them in the PR title. For example, "PARQUET-1234: My Parquet PR"
- - https://issues.apache.org/jira/browse/PARQUET-XXX
- - In case you are adding a dependency, check if the license complies with
the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
+Please open a GitHub issue for this pull request:
https://github.com/apache/parquet-format/issues/new/choose
+and format pull request title as below:
-### Commits
+ GH-${GITHUB_ISSUE_ID}: ${SUMMARY}
-- [ ] My commits all reference Jira issues in their subject lines. In
addition, my commits follow the guidelines from "[How to write a good git
commit message](http://chris.beams.io/posts/git-commit/)":
- 1. Subject is separated from body by a blank line
- 1. Subject is limited to 50 characters (not including Jira issue reference)
- 1. Subject does not end with a period
- 1. Subject uses the imperative mood ("add", not "adding")
- 1. Body wraps at 72 characters
- 1. Body explains "what" and "why", not "how"
+or simply use the title below if it is a minor issue:
-### Documentation
+ MINOR: ${SUMMARY}
-- [ ] In case of new functionality, my PR adds documentation that describes
how to use it.
- - All the public functions and the classes in the PR contain Javadoc that
explain what it does
+-->
+
+### Rationale for this change
+
+
+### What changes are included in this PR?
+
+
+### Do these changes have PoC implementations?
+
+
+<!-- Please uncomment the line below and replace ${GITHUB_ISSUE_ID} with the
actual Github issue id. -->
+<!-- Closes #${GITHUB_ISSUE_ID} -->
