[ 
https://issues.apache.org/jira/browse/FLINK-41588?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Harshit Gupta updated FLINK-41588:
----------------------------------
    Description: 
In PR [https://github.com/apache/flink/pull/28643] we realised that Flink does 
not have any pre-commit check to make sure commit messages align with Flink's 
coding style guidelines as mentioned in 
[https://flink.apache.org/how-to-contribute/code-style-and-quality-pull-requests/.|https://flink.apache.org/how-to-contribute/code-style-and-quality-pull-requests/]
 The use case is to enforce coding these coding style guidelines.

 

The idea is to either use 
[https://github.com/apache/calcite/blob/main/core/src/test/java/org/apache/calcite/test/LintTest.java]
 from Calcite (Probably extracting this into a separate library which can be 
used by both these projects, maybe other projects in the Flink environment) or 
use other tools which fit best for this usecase. The Jira for the LintTest is 
https://issues.apache.org/jira/browse/CALCITE-5765 

 

Open questions right now
 * Which tool to use for the pre-commit check? Does the Calcite self built tool 
also fulfils this usecase?
 * Which all rules do we want to enforce in this pre-commit check?

  was:
In PR [https://github.com/apache/flink/pull/28643] we realised that Flink does 
not have any pre-commit check to make sure commit messages align with Flink's 
coding style guidelines as mentioned in 
[https://flink.apache.org/how-to-contribute/code-style-and-quality-pull-requests/.|https://flink.apache.org/how-to-contribute/code-style-and-quality-pull-requests/]
 The use case is to enforce coding these coding style guidelines.

 

The idea is to either use 
[https://github.com/apache/calcite/blob/main/core/src/test/java/org/apache/calcite/test/LintTest.java]
 from Calcite (Probably extracting this into a separate library which can be 
used by both these projects, maybe other projects in the Flink environment) or 
use other tools which fit best for this usecase.

 

Open questions right now
 * Which tool to use for the pre-commit check? Does the Calcite self built tool 
also fulfils this usecase?
 * Which all rules do we want to enforce in this pre-commit check?


> Pre-Commit Prefix Check
> -----------------------
>
>                 Key: FLINK-41588
>                 URL: https://issues.apache.org/jira/browse/FLINK-41588
>             Project: Flink
>          Issue Type: Improvement
>            Reporter: Harshit Gupta
>            Priority: Minor
>
> In PR [https://github.com/apache/flink/pull/28643] we realised that Flink 
> does not have any pre-commit check to make sure commit messages align with 
> Flink's coding style guidelines as mentioned in 
> [https://flink.apache.org/how-to-contribute/code-style-and-quality-pull-requests/.|https://flink.apache.org/how-to-contribute/code-style-and-quality-pull-requests/]
>  The use case is to enforce coding these coding style guidelines.
>  
> The idea is to either use 
> [https://github.com/apache/calcite/blob/main/core/src/test/java/org/apache/calcite/test/LintTest.java]
>  from Calcite (Probably extracting this into a separate library which can be 
> used by both these projects, maybe other projects in the Flink environment) 
> or use other tools which fit best for this usecase. The Jira for the LintTest 
> is https://issues.apache.org/jira/browse/CALCITE-5765 
>  
> Open questions right now
>  * Which tool to use for the pre-commit check? Does the Calcite self built 
> tool also fulfils this usecase?
>  * Which all rules do we want to enforce in this pre-commit check?



--
This message was sent by Atlassian Jira
(v10.3.26#10030026)

Reply via email to