You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by li...@apache.org on 2022/09/27 11:02:31 UTC
[flink-ml] branch master updated: [FLINK-29424] Add Pull Request Template
This is an automated email from the ASF dual-hosted git repository.
lindong pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-ml.git
The following commit(s) were added to refs/heads/master by this push:
new 8a79231 [FLINK-29424] Add Pull Request Template
8a79231 is described below
commit 8a792318ebee3c076244bc95dce82fc448e7a172
Author: JiangXin <j_...@163.com>
AuthorDate: Tue Sep 27 19:02:25 2022 +0800
[FLINK-29424] Add Pull Request Template
This closes #159.
---
.github/PULL_REQUEST_TEMPLATE.md | 38 ++++++++++++++++++++++++++++++++++++++
1 file changed, 38 insertions(+)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..3b481cf
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,38 @@
+<!--
+*Thank you very much for contributing to Apache Flink ML - we are happy that you want to help us improve Flink ML. To help the community review your contribution in the best possible way, please go through the checklist below, which will get the contribution into a shape in which it can be best reviewed.*
+
+## Contribution Checklist
+
+ - Make sure that the pull request corresponds to one [JIRA issue](https://issues.apache.org/jira/projects/FLINK/issues). Exceptions are made for typos in JavaDoc or documentation files, which need no JIRA issue.
+
+ - Name the pull request in the form "[FLINK-XXXX] Title of the pull request", where *FLINK-XXXX* should be replaced by the actual issue number.
+ Typo fixes that have no associated JIRA issue should be named following this pattern: `[hotfix] Title of the pull request`.
+
+ - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
+
+ - Each commit in the pull request has a meaningful commit message (including the JIRA id)
+
+ - Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
+
+**(The sections below can be removed for hotfixes of typos)**
+-->
+
+## What is the purpose of the change
+
+*(For example: This pull request adds the implementation of Naive Bayes algorithm.)*
+
+## Brief change log
+
+*(for example:)*
+ - *Adds Transformer and Estimator implementation of Naive Bayes in Java and Python*
+ - *Adds examples and documentations of Naive Bayes*
+
+## Does this pull request potentially affect one of the following parts:
+
+ - Dependencies (does it add or upgrade a dependency): (yes / no)
+ - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (yes / no)
+
+## Documentation
+
+ - Does this pull request introduce a new feature? (yes / no)
+ - If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)