Skip to content

Commit

Permalink
[ci] Add pull request template in ci #130
Browse files Browse the repository at this point in the history
  • Loading branch information
czy006 authored and itinycheng committed Jun 13, 2024
1 parent 6a2c76b commit b905d4a
Show file tree
Hide file tree
Showing 3 changed files with 225 additions and 0 deletions.
112 changes: 112 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
#
# 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: Apache Flink Clickhouse Connector Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["type:bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
We really appreciate the community's efforts to improve Clickhouse Connector.
Please feel free to report the problem you encountered.
If you're sure that it is indeed a bug, please try your best to log the reproducible steps.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Please provide the context in which the problem occurred and explain what happened
validations:
required: true

- type: input
id: version
attributes:
label: Affects Versions
description: What version of Clickhouse Connector are affected by this bug?
placeholder: >
e.g. master/1.18/1.19/1.20/...
validations:
required: true

- type: dropdown
id: engines
attributes:
label: What are you seeing the problem on?
multiple: true
options:
- Clickhouse-Client
- Connector Connection
- Flink-Table-Api (SQL)
- Flink-DataStream-Api
- Ci
- Docs

- type: textarea
id: reproduce
attributes:
label: How to reproduce
description: >
What should we do to reproduce the problem?
placeholder: >
Please make sure you provide a reproducible step-by-step case of how to reproduce the problem
as minimally and precisely as possible. Keep in mind we do not have access to your cluster.
Remember that non-reproducible issues will be closed! Opening a discussion is recommended as a
first step.
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell

- type: textarea
attributes:
label: Anything else
description: Anything else we need to know?
placeholder: >
e.g How often does this problem occur? (Once? Every time? Only when certain conditions are met?)
validations:
required: false

- type: checkboxes
attributes:
label: Are you willing to submit a 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 fix the bug.
Connector is a community-managed project and we love to bring new contributors in.
options:
- label: Yes I am willing to submit a PR!

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
options:
- label: I agree to follow this project's Code of Conduct
required: true

- type: markdown
attributes:
value: "Thanks for completing our form!"
73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/sub_task.yml
Original file line number Diff line number Diff line change
@@ -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
#
# 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: Apache Flink Clickhouse Connector Subtask
title: "[Subtask]: "
description: Subtask of another issue
labels: [ "type:subtask" ]
body:
- type: markdown
attributes:
value: |
Thank you for contributing to Connector!
- type: checkboxes
attributes:
label: Search before asking
options:
- label: >
I have searched in the [issues](https://github.com/itinycheng/flink-connector-clickhouse/issues?q=is%3Aissue) and found no similar
issues.
required: true
- type: textarea
attributes:
label: Description
description: A short description of your subtask

- type: textarea
attributes:
label: Parent issue
placeholder: >
Please put the parent issue link here.
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 feature.
Connector is a community-managed 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: The Code of Conduct helps create a safe space for everyone. We require
that everyone agrees to it.
options:
- label: >
I agree to follow this project's
[Code of Conduct](https://www.apache.org/foundation/policies/conduct)
required: true
- type: markdown
attributes:
value: "Thanks for completing our form!"
40 changes: 40 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!--
Thanks for sending a pull request!

Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://flink.apache.org/how-to-contribute/overview/
2. If the PR is related to an issue in https://github.com/itinycheng/flink-connector-clickhouse/issues, add '[Hotfix/Fix/Feature/-XXX(issues-id)]' in your PR title, e.g., '[Fix/Feature/-XXXX] Your PR title ...'.
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][Fix/Feature/-XXX] Your PR title ..
.'.
-->

## Why are the changes needed?

<!--
Please clarify why the changes are needed. For instance,
1. If you add a feature, you can talk about its use case.
2. If you fix a bug, you can clarify why it is a bug.
3. Use Fix/Resolve/Close #{ISSUE_NUMBER} to link this PR to its related issue
-->

Close #xxx.

## Brief change log
<!--
Clearly describe the changes made in modules, classes, methods, etc.
-->

-

## How was this patch tested?

- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [ ] Run test locally before making a pull request

## Documentation

- Does this pull request introduce a new feature? (yes / no)
- If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)

0 comments on commit b905d4a

Please sign in to comment.