[ 
https://issues.apache.org/jira/browse/AMBARI-26356?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17937763#comment-17937763
 ] 

Jialiang Cai edited comment on AMBARI-26356 at 3/24/25 1:39 AM:
----------------------------------------------------------------

Good idea, I think we should also update the documentation: 
[https://ambari.staged.apache.org/] is the staging preview documentation, and 
the source is at https://github.com/apache/ambari-website


was (Author: JIRAUSER298676):
Good idea, I think we should also update the documentation: 
https://ambari.staged.apache.org/ is the staging preview documentation, and the 
source is at https://github.com/apache/

> Implement Code Quality Enforcement using GitHub Actions and Optional 
> Pre-Commit Hooks
> -------------------------------------------------------------------------------------
>
>                 Key: AMBARI-26356
>                 URL: https://issues.apache.org/jira/browse/AMBARI-26356
>             Project: Ambari
>          Issue Type: Improvement
>            Reporter: Nikita Pande
>            Priority: Major
>              Labels: github-actions, pre-commit
>
> The Apache Ambari project benefits from consistent code quality, style, and 
> validation. Currently, there isn't a fully enforced, automated system, 
> leading to potential inconsistencies, increased code review overhead, and a 
> higher chance of errors slipping through. Relying solely on 
> contributor-managed local setups for checks is not scalable or reliable for a 
> project of Ambari's size and distributed nature.
> Proposed Solution:
>  * *Mandatory GitHub Actions Workflow:* Implement a GitHub Actions workflow 
> to perform all essential code quality and validation checks on every pull 
> request. This ensures that all contributions adhere to project standards.
>  * *Optional Local Pre-Commit Hooks:* Provide pre-commit hooks as a 
> _convenience_ for developers who want to run these checks locally _before_ 
> pushing their code. This is not a substitute for the mandatory GitHub Actions 
> checks.
> It can include following checks for Ambari
>  * License Checks
>  * JIRA ID Check in Commit Names
>  * UI linting 
>  * Pre-Commit Test Suite
>  * Pretty / formatting checks
> *Benefits:*
>  * Improved code quality and consistency.
>  * Reduced code review effort.
>  * Early detection of errors.
>  * Enhanced project maintainability.
>  * Improved compliance.
>  



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to