AOSSIE-Org / AOSSIE-Org/Resonate

DX: Implement Pre-commit Hooks for Automated Dart Formatting and Linting

未关闭
#682 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Dart
星标
344
派生
350
PR 合并指标
30 天内没有已合并 PR

描述

Description
The Problem: Currently, the Resonate project relies on GitHub Actions (CI) to catch formatting and linting errors. While effective, this creates a slow feedback loop for contributors:
A contributor pushes code.
They wait several minutes for CI to run.
CI fails because of a missing comma or a formatting nitpick.
The contributor has to push a "fix formatting" commit, cluttering the git history.

The Suggestion: I propose adding a .pre-commit-config.yaml file to the root directory. This will allow developers to use the pre-commit framework to automatically run dart format and dart analyze locally before a commit is even created.

Benefits:
Cleaner Git History: No more "fix linting" or "apply dart format" commits.
Faster Feedback: Contributors see errors instantly in their terminal.
Standardization: Ensures every PR adheres to the project's specific analysis_options.yaml without manual oversight.

Proposed Implementation
The implementation would involve adding a configuration file using the pre-commit framework with hooks specifically for the Dart SDK

As an aspiring GSoC contributor, it will be a great learning experience for me if I get to work on this issue. Looking forward to get assigned. Thanks !

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。