diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..ad64df1f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,65 @@ +# ---------------------------------------------------------------------------- +# 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 +# +# https://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: Report a defect or unexpected behavior +title: "bug: " +labels: [bug] +assignees: [] +body: + - type: dropdown + id: language + attributes: + label: Language + description: Which language implementation this issue is about. + multiple: true + options: + - Java + - C++ + - Python + - Other + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: What happened and what you expected. + validations: + required: true + - type: textarea + id: repro + attributes: + label: Reproduction steps + description: Minimal reproducible steps, ideally with minimal code or data. + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: TsFile version and build method. + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Logs, error messages, or anything you have already investigated. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..0472581e1 --- /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 +# +# https://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: Apache TsFile Community + url: https://github.com/apache/tsfile/discussions + about: For usage or non-defect questions, please use Discussions. diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 000000000..65b46403b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,39 @@ +# ---------------------------------------------------------------------------- +# 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 +# +# https://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: Documentation +description: Missing, incorrect, or unclear documentation +title: "docs: " +labels: [documentation] +assignees: [] +body: + - type: input + id: location + attributes: + label: Location + description: File path or page URL. + validations: + required: true + - type: textarea + id: issue + attributes: + label: Issue + description: What is missing or incorrect, and how it should read. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 000000000..6dd157def --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,73 @@ +# ---------------------------------------------------------------------------- +# 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 +# +# https://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: Propose a new feature or capability +title: "feature: " +labels: [enhancement] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to propose a new feature for Apache TsFile! + - type: dropdown + id: language + attributes: + label: Language + description: Which language implementation this issue is about. + multiple: true + options: + - Java + - C++ + - Python + - Other + validations: + required: true + + - type: textarea + id: motivation + attributes: + label: Motivation + description: What problem this solves and why it cannot be done today. + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Expected behavior + description: What capability should be added and how it should behave. + validations: + required: true + - type: textarea + id: acceptance + attributes: + label: Acceptance criteria + description: Verifiable completion criteria. + - type: dropdown + id: model + attributes: + label: Write model + description: Which write model this feature targets. + options: + - Table model + - Tree model + - Both + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 000000000..3fb0c53ba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -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 +# +# https://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: A usage, design, or compatibility question (not a defect) +title: "question: " +labels: [question] +assignees: [] +body: + - type: textarea + id: question + attributes: + label: Question + description: What you want to confirm and what you have already tried. + validations: + required: true