You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by xt...@apache.org on 2025/06/11 11:18:53 UTC
(flink-agents) branch main updated (d0482d7 -> 58bb0f7)
This is an automated email from the ASF dual-hosted git repository.
xtsong pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/flink-agents.git
from d0482d7 Improves the usability of lint/ut scripts (#5)
new b99a4bf Add Github Issues templates.
new 58bb0f7 Add Github Pull Request template.
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.github/ISSUE_TEMPLATE/1-bug.yml | 56 ++++++++++++++++++++++
.github/ISSUE_TEMPLATE/2-feature.yml | 44 +++++++++++++++++
.github/ISSUE_TEMPLATE/3-techdebt.yml | 45 +++++++++++++++++
.../ISSUE_TEMPLATE/config.yml | 4 +-
.github/PULL_REQUEST_TEMPLATE.md | 23 +++++++++
5 files changed, 171 insertions(+), 1 deletion(-)
create mode 100644 .github/ISSUE_TEMPLATE/1-bug.yml
create mode 100644 .github/ISSUE_TEMPLATE/2-feature.yml
create mode 100644 .github/ISSUE_TEMPLATE/3-techdebt.yml
copy python/flink_agents/plan/__init__.py => .github/ISSUE_TEMPLATE/config.yml (95%)
create mode 100644 .github/PULL_REQUEST_TEMPLATE.md
(flink-agents) 02/02: Add Github Pull Request template.
Posted by xt...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
xtsong pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-agents.git
commit 58bb0f7c1292235d842ebe66a8f9fbdc189bdfd6
Author: Xintong Song <to...@gmail.com>
AuthorDate: Wed Jun 11 19:02:10 2025 +0800
Add Github Pull Request template.
---
.github/PULL_REQUEST_TEMPLATE.md | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..33f16b9
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,23 @@
+<!--
+* Thank you very much for contributing to Flink Agents.
+* Please add the relevant components in the PR title. E.g., [api], [runtime], [java], [python], [hotfix], etc.
+-->
+
+<!-- Please link the PR to the relevant issue(s). Hotfix doesn't need this. -->
+Linked issue: #xxx
+
+### Purpose of change
+
+<!-- What is the purpose of this change? -->
+
+### Tests
+
+<!-- How is this change verified? -->
+
+### API
+
+<!-- Does this change touches any public APIs? -->
+
+### Documentation
+
+<!-- Should this change be covered by the user documentation?-->
(flink-agents) 01/02: Add Github Issues templates.
Posted by xt...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
xtsong pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-agents.git
commit b99a4bf9d20e411188d727acf5933525e2e26598
Author: Xintong Song <to...@gmail.com>
AuthorDate: Wed Jun 11 17:56:54 2025 +0800
Add Github Issues templates.
---
.github/ISSUE_TEMPLATE/1-bug.yml | 56 +++++++++++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/2-feature.yml | 44 +++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/3-techdebt.yml | 45 ++++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/config.yml | 19 ++++++++++++
4 files changed, 164 insertions(+)
diff --git a/.github/ISSUE_TEMPLATE/1-bug.yml b/.github/ISSUE_TEMPLATE/1-bug.yml
new file mode 100644
index 0000000..81b3898
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/1-bug.yml
@@ -0,0 +1,56 @@
+################################################################################
+# 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: Something isn't working as expected.
+title: "[Bug] "
+labels: ["bug"]
+body:
+ - type: markdown
+ attributes:
+ value: Thank you very much for your feedback!
+ - type: checkboxes
+ attributes:
+ label: Search before asking
+ description: Please search for similar issues before creating a new one.
+ options:
+ - label: I searched in the [issues](https://github.com/apache/flink-agents/issues) and found nothing similar.
+ required: true
+ - type: textarea
+ attributes:
+ label: Description
+ description: Please describe the problem you are facing. What are the expected behaviors and what you are actually seeing. Any error messages and logs are also helpful.
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: How to reproduce
+ description: Please provide the steps to reproduce this problem.
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Version and environment
+ description: Please provide the Flink Agent version you're using. Additional information such as Flink version and deployment mode, Java / Python environments and OS architecture may also be helpful.
+ validations:
+ required: true
+ - type: checkboxes
+ attributes:
+ label: Are you willing to submit a PR?
+ options:
+ - label: I'm willing to submit a PR!
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/2-feature.yml b/.github/ISSUE_TEMPLATE/2-feature.yml
new file mode 100644
index 0000000..f973a73
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2-feature.yml
@@ -0,0 +1,44 @@
+################################################################################
+# 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
+description: New features or improvements to existing features.
+title: "[Feature] "
+labels: ["feature"]
+body:
+ - type: markdown
+ attributes:
+ value: Thank you very much for your feature proposal!
+ - type: checkboxes
+ attributes:
+ label: Search before asking
+ description: Please search for similar issues before creating a new one.
+ options:
+ - label: I searched in the [issues](https://github.com/apache/flink-agents/issues) and found nothing similar.
+ required: true
+ - type: textarea
+ attributes:
+ label: Description
+ description: Please describe the proposed feature or improvement. What problem does it solve? Or what value does it bring? Do you already have a solution in mind?
+ validations:
+ required: true
+ - type: checkboxes
+ attributes:
+ label: Are you willing to submit a PR?
+ options:
+ - label: I'm willing to submit a PR!
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/3-techdebt.yml b/.github/ISSUE_TEMPLATE/3-techdebt.yml
new file mode 100644
index 0000000..91f9a3a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/3-techdebt.yml
@@ -0,0 +1,45 @@
+################################################################################
+# 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: Technical Debt
+description: User-unaware issues, such as code refactor and infrastructure maintenance.
+title: "[Tech Debt] "
+labels: ["tech debt"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thank you very much for raising the technical debt!
+ - type: checkboxes
+ attributes:
+ label: Search before asking
+ description: Please search for similar issues before creating a new one.
+ options:
+ - label: I searched in the [issues](https://github.com/apache/flink-agents/issues) and found nothing similar.
+ required: true
+ - type: textarea
+ attributes:
+ label: Description
+ description: Please describe the task. What is currently not ideal? How should it be fixed or improved?
+ validations:
+ required: true
+ - type: checkboxes
+ attributes:
+ label: Are you willing to submit a PR?
+ options:
+ - label: I'm willing to submit a PR!
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..126252d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,19 @@
+################################################################################
+# 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
\ No newline at end of file