mlcommons/algorithmic-efficiency

Optimize Git Hook Configuration

Open

#853 opened on Mar 13, 2025

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (76 forks)auto 404
Good First Issue

Repository metrics

Stars
 (422 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

Our current setup uses pre-commit hooks to enforce code quality checks before each commit. While this helps maintain consistency, it can slow down development.

To balance consistency and efficiency, we can:

  • Switch to Pre-Push Hooks

    • Runs checks before pushing to the remote repository, reducing interruptions during commits.
    • Since most pre-commit checks handle formatting, fixing them before pushing is sufficient (unlike API keys, which should never be committed).

  • Provide a Makefile for Manual Pre-Commit Checks

    • Developers can run make pre-commit periodically to format and clean up code in bulk.
    • This avoids enforcing checks on every commit while still ensuring consistency.

By combining pre-push hooks and a Makefile, we ensure that checks happen at the right time—automatically before pushing, with an option for developers to run them manually when needed.

Contributor guide

Research direction
Review the existing pre commit setup and Makefile. Then, learn how to configure pre push hooks in this repository (likely via pre commit) and add a make target to run the checks manually.
Tech stack
pythonshell
Domain
developer experiencetooling
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitShell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75