AOSSIE-Org / AOSSIE-Org/Resonate

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

Offen
#682 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Dart
Sterne
344
Forks
350
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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 !

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.