flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From se...@apache.org
Subject flink git commit: [FLINK-7263] [docs] Extend the PR template
Date Wed, 26 Jul 2017 13:56:39 GMT
Repository: flink
Updated Branches:
  refs/heads/master 113b8c41d -> 3e12673a5


[FLINK-7263] [docs] Extend the PR template

This closes #4395


Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/3e12673a
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/3e12673a
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/3e12673a

Branch: refs/heads/master
Commit: 3e12673a54f398c5fed03e4bb53a2a9a787f4c16
Parents: 113b8c4
Author: Stephan Ewen <sewen@apache.org>
Authored: Mon Jul 17 18:08:41 2017 +0200
Committer: Stephan Ewen <sewen@apache.org>
Committed: Wed Jul 26 15:53:46 2017 +0200

----------------------------------------------------------------------
 .github/PULL_REQUEST_TEMPLATE.md | 88 ++++++++++++++++++++++++++++-------
 1 file changed, 71 insertions(+), 17 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/3e12673a/.github/PULL_REQUEST_TEMPLATE.md
----------------------------------------------------------------------
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 5f4c2fe..703e1ce 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,17 +1,71 @@
-Thanks for contributing to Apache Flink. Before you open your pull request, please take the
following check list into consideration.
-If your changes take all of the items into account, feel free to open your pull request.
For more information and/or questions please refer to the [How To Contribute guide](http://flink.apache.org/how-to-contribute.html).
-In addition to going through the list, please provide a meaningful description of your changes.
-
-- [ ] General
-  - The pull request references the related JIRA issue ("[FLINK-XXX] Jira title text")
-  - The pull request addresses only one issue
-  - Each commit in the PR has a meaningful commit message (including the JIRA id)
-
-- [ ] Documentation
-  - Documentation has been added for new functionality
-  - Old documentation affected by the pull request has been updated
-  - JavaDoc for public methods has been added
-
-- [ ] Tests & Build
-  - Functionality added by the pull request is covered by tests
-  - `mvn clean verify` has been executed successfully locally or a Travis build has passed
+
+*Thank you very much for contributing to Apache Flink - we are happy that you want to help
us improve Flink. 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.*
+
+*Please understand that we do not do this to make contributions to Flink a hassle. In order
to uphold a high standard of quality for code contributions, while at the same time managing
a large number of contributions, we need contributors to prepare the contributions well, and
give reviewers enough contextual information for the review. Please also understand that contributions
that do not follow this guide will take longer to review and thus typically be picked up with
lower priority by the community.*
+
+## Contribution Checklist
+
+  - Make sure that the pull request corresponds to a [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-1234] [component] Title of the pull request",
where *FLINK-1234* should be replaced by the actual issue number. Skip *component* if you
are unsure about which is the best component.
+  Typo fixes that have no associated JIRA issue should be named following this pattern: `[hotfix]
[docs] Fix typo in event time introduction` or `[hotfix] [javadocs] Expand JavaDoc for PuncuatedWatermarkGenerator`.
+
+  - 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.
+  
+  - Make sure that the change passes the automated tests, i.e., `mvn clean verify` passes.
You can set up Travis CI to do that following [this guide](http://flink.apache.org/contribute-code.html#best-practices).
+
+  - Each pull request should address only one issue, not mix up code from multiple issues.
+  
+  - 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 makes task deployment go through the blob server, rather
than through RPC. That way we avoid re-transferring them on each deployment (during recovery).)*
+
+
+## Brief change log
+
+*(for example:)*
+  - *The TaskInfo is stored in the blob store on job creation time as a persistent artifact*
+  - *Deployments RPC transmits only the blob storage reference*
+  - *TaskManagers retrieve the TaskInfo from the blob cache*
+
+
+## Verifying this change
+
+*(Please pick either of the following options)*
+
+This change is a trivial rework / code cleanup without any test coverage.
+
+*(or)*
+
+This change is already covered by existing tests, such as *(please describe tests)*.
+
+*(or)*
+
+This change added tests and can be verified as follows:
+
+*(example:)*
+  - *Added integration tests for end-to-end deployment with large payloads (100MB)*
+  - *Extended integration test for recovery after master (JobManager) failure*
+  - *Added test that validates that TaskInfo is transferred only once across recoveries*
+  - *Manually verified the change by running a 4 node cluser with 2 JobManagers and 4 TaskManagers,
a stateful streaming program, and killing one JobManager and two TaskManagers during the execution,
verifying that recovery happens correctly.*
+
+## 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)
+  - The serializers: (yes / no / don't know)
+  - The runtime per-record code paths (performance sensitive): (yes / no / don't know)
+  - Anything that affects deployment or recovery: JobManager (and its components), Checkpointing,
Yarn/Mesos, ZooKeeper: (yes / no / don't know)
+
+## Documentation
+
+  - Does this pull request introduce a new feature? (yes / no)
+  - If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
+


Mime
View raw message