flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] TisonKun commented on a change in pull request #6722: [FLINK-10378] [github] Hide/Comment out contribute guide from PULL_REQUEST_TEMPLATE
Date Thu, 20 Sep 2018 13:57:53 GMT
TisonKun commented on a change in pull request #6722: [FLINK-10378] [github] Hide/Comment out
contribute guide from PULL_REQUEST_TEMPLATE
URL: https://github.com/apache/flink/pull/6722#discussion_r219173779
 
 

 ##########
 File path: .github/PULL_REQUEST_TEMPLATE.md
 ##########
 @@ -1,14 +1,13 @@
+<!--
+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.
 
-*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 require 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.
 
-*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
+**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-XXXX] [component] Title of the pull request",
where *FLINK-XXXX* 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`.
+  - Name the pull request in the form "[FLINK-XXXX] [component] Title of the pull request",
where *FLINK-XXXX* 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".
 
 Review comment:
   merge two lines is subjective, just because I find it weird a separated paragraph within
items. feel free to revert it, I do not insist this.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message