You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by StephanEwen <gi...@git.apache.org> on 2017/07/25 12:36:30 UTC
[GitHub] flink pull request #4395: [FLINK-7263] Improve Pull Request template
GitHub user StephanEwen opened a pull request:
https://github.com/apache/flink/pull/4395
[FLINK-7263] Improve Pull Request template
As discussed on the [mailing list](https://lists.apache.org/thread.html/0a27a9faa6a4895fae74ea2e6795334967b8914af43fa49eec5f060d@%3Cdev.flink.apache.org%3E), here is a suggestion to make extend the pull request template.
## Main goals
- Communicating more clearly the prerequisites for every contribution to foster high quality pull requests
- Encouraging more thorough description of change and ways to verify the change to help reviewers.
- Clearly marking pull requests that tough potentially sensitive parts of the system, to make contributors and reviewers explicitly reflect on potential implications.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/StephanEwen/incubator-flink pr_template
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/4395.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #4395
----
commit 48c9e823c4179e516cad521ec4e849d4df3600d0
Author: Stephan Ewen <se...@apache.org>
Date: 2017-07-17T16:08:41Z
Update PR template
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink issue #4395: [FLINK-7263] Improve Pull Request template
Posted by StephanEwen <gi...@git.apache.org>.
Github user StephanEwen commented on the issue:
https://github.com/apache/flink/pull/4395
## Discussion points so far
- Is the text to verbose and should it be moved to the "how to contribute" section?
- pro: less text in the template
- con: "how to contribute" is frequently not read, text in the template only relevant for first time contributors (who we want to read it) and does not hurt repeated contributors (can simply skip/scroll over text)
- Improve the sample texts (currently too much oriented at low level contributions)
- Checkboxes versus *yes / no / don't know*
- pro: check boxes are visually nicer
- con: markdown checkboxes may be confusing to users, unchecked boxes are hard to distinguish between 'no' and 'did not know what to do'. Explicitly having *don't know* makes it clearer for contributors to not just skip that question when they are unsure. Seems more intuitive to allow for free text answers as well (if neither option works)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4395: [FLINK-7263] Improve Pull Request template
Posted by greghogan <gi...@git.apache.org>.
Github user greghogan commented on a diff in the pull request:
https://github.com/apache/flink/pull/4395#discussion_r129310148
--- Diff: .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 you 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`
+
+ - 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 to TaskManagers during the execution, verifying that recovery happens correctly.*
--- End diff --
two TaskManagers
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4395: [FLINK-7263] Improve Pull Request template
Posted by StephanEwen <gi...@git.apache.org>.
Github user StephanEwen closed the pull request at:
https://github.com/apache/flink/pull/4395
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink issue #4395: [FLINK-7263] Improve Pull Request template
Posted by StephanEwen <gi...@git.apache.org>.
Github user StephanEwen commented on the issue:
https://github.com/apache/flink/pull/4395
Thanks for the review @greghogan , will fix these.
Given the agreement in the mailing list discussion to try it out, I would like to go ahead and merge this. We should make continuous improvements with pull requests over time as we learn if it works or gets in the way...
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4395: [FLINK-7263] Improve Pull Request template
Posted by greghogan <gi...@git.apache.org>.
Github user greghogan commented on a diff in the pull request:
https://github.com/apache/flink/pull/4395#discussion_r129307869
--- Diff: .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 you 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.*
--- End diff --
your contribution
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4395: [FLINK-7263] Improve Pull Request template
Posted by greghogan <gi...@git.apache.org>.
Github user greghogan commented on a diff in the pull request:
https://github.com/apache/flink/pull/4395#discussion_r129307702
--- Diff: .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 you 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`
+
+ - 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 to 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)**
--- End diff --
If we leave these unbolded then the user can mark the choice by simply selecting and ⌘-B.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4395: [FLINK-7263] Improve Pull Request template
Posted by greghogan <gi...@git.apache.org>.
Github user greghogan commented on a diff in the pull request:
https://github.com/apache/flink/pull/4395#discussion_r129309487
--- Diff: .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 you 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`
--- End diff --
Can we reference TravisCI also or instead? After a `mvn clean` I have found IntelliJ to stumble while building `ILoopCompat` and other (typically) Scala files.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---