Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH-2930: Add issue templates #2931

Merged
merged 6 commits into from
Jul 3, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# 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
- type: dropdown
id: component
attributes:
label: Component(s)
multiple: true
options:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we actually need these options? Or should it be consistent with modules like parquet-avro, parquet-cli, etc.? Same question for other yamls.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also please note I introduced as many new labels as I could during migration. We now might want to reduce the current set by deleting them here (delete is irreversible). Same goes for milestones.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • I would not add the modules as is. It does not make sense to differentiate e.g. parquet-common, parquet-column, or parquet-hadoop (etc.). These are all parts of the "core".
  • It might make sense to mention the "bindings" separately (parquet-arrow, parquet-avro, parquet-pig, parquet-protobuf, parquet-scala, parquet-thrift).
  • If we want to list components, Java is too wide.
  • I think it makes more sense to somehow sum up Release+CI+Packaging.
  • What is Documentation? Adding javadocs? I would add these changes to the related module instead.
  • I would add parquet-cli as a separate item

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback @gszadovszky. I've change the list like so:

      options:
-       - Java
        - Release
-       - Documentation
        - Continuous Integration
-       - Packaging
+       - Arrow
+       - Avro
+       - Pig
+       - Protobuf
+       - Scala
+       - Thrift
+       - CLI
        - Benchmarking
        - Other

I think it makes more sense to somehow sum up Release+CI+Packaging.

Agreed, but I don't have a good suggestion how. For now I just removed packaging.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @rok!

It would be nice to see somehow how many issues we have related to CI and Release. Maybe Other is enough but not sure. I am fine as is, though.

One thing is clearly missing. This is the core functionality that most PRs have updates in. These are the modules parquet-column, parquet-common, parquet-encoding, parquet-format-structures, parquet-generator, parquet-hadoop. I am fine calling it Core if there are no better suggestion.

parquet-hadoop is definitely part of core currently, even though we want to get rid of the hadoop dependencies. After this work would be done, the separate component Hadoop would make sense, but currently I don't think we need it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rok for working on this 🙌 I would be inclined to remove Other and make it optional. WDYT?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback! :D I've pushed a change and here's the current list:

- Core
- Release
- Continuous Integration
- Arrow
- Avro
- Pig
- Protobuf
- Scala
- Thrift
- CLI
- Benchmarking

I'm glad to defer to your suggestions as I'm quite unfamiliar with parquet-java (except for the migration).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more thing, I was looking at Iceberg regarding @gszadovszky's comment.

I think it makes more sense to somehow sum up Release+CI+Packaging.

At Iceberg we've packaged these into a Build label.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like a good idea. Will do.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

- Core
- Build
- Arrow
- Avro
- Pig
- Protobuf
- Scala
- Thrift
- CLI
- Benchmark
validations:
required: false
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -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
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 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
- type: dropdown
id: component
attributes:
label: Component(s)
multiple: true
options:
- Core
- Build
- Arrow
- Avro
- Pig
- Protobuf
- Scala
- Thrift
- CLI
- Benchmarking
wgtmac marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: false
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/usage_question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# 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: Usage Question
description: Ask a question
labels: ["Type: usage"]
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
- type: dropdown
id: component
attributes:
label: Component(s)
multiple: true
options:
- Core
- Build
- Arrow
- Avro
- Pig
- Protobuf
- Scala
- Thrift
- CLI
- Benchmarking
wgtmac marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: false