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:56:06 UTC
(flink-agents) branch main updated: Add contribution guidelines.
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
The following commit(s) were added to refs/heads/main by this push:
new 7be07a5 Add contribution guidelines.
7be07a5 is described below
commit 7be07a5a78612d6eb5d299ee2811bfdbcb5d3611
Author: Xintong Song <to...@gmail.com>
AuthorDate: Wed Jun 11 19:55:50 2025 +0800
Add contribution guidelines.
---
.github/CONTRIBUTING.md | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..a27a8b7
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+# How to contribute to Flink Agents
+
+Thank you for your intention to contribute the Flink Agents project!
+
+## Report a bug
+1. Search in the [issues](https://github.com/apache/flink-agents/issues) to see if the bug has already been reported. If so, please add a comment to the existing issue instead of opening a new one.
+2. If not, please open a new Bug Report issue.
+
+## Propose or request a new feature
+1. Search in the [issues](https://github.com/apache/flink-agents/issues) to see if the feature has already been requested. If so, please add a comment to the existing issue instead of opening a new one.
+2. If not, please open a new Feature Request.
+
+## Code contribution
+1. For hotfix commits (typo fixes, minor pure refactors, etc.) that does not introduce any behavior changes, please open a pull request directly.
+2. For other code changes, please open an issue about it and make sure there's at least one committer supports it before opening the pull request. And please link the issue in the pull request.
+3. Please add the relevant components in the PR title. E.g., \[api\], \[runtime\], \[java\], \[python\], \[hotfix\], etc.
+
+## Design discussions
+1. Minor design changes can be discussed directly in the issue.
+2. Significant design changes should be discussed as [ideas](https://github.com/apache/flink-agents/discussions/categories/ideas) with proper design docs. All issues for conducting the changes should link to the discussion thread.
\ No newline at end of file