atxtechbro / atxtechbro/dotfiles

Implement git hooks in dotfiles repository

Open
#157 0 comments 0 reactions 0 assignees View on GitHub
enhancement git security
Dominant language
Shell
Stars
27
Forks
2
PR merge metrics
No merged PRs in 30d

Description

## Overview
Add git hooks to the dotfiles repository to enforce coding standards, prevent sensitive information from being committed, and catch issues early in the development process.

## Background
The driver is actively learning about git hooks and wants to explore their implementation. This is a theme of focus for the coming weeks/month.

## Requirements
- Create a directory structure for git hooks in the dotfiles repository
- Implement basic hooks that demonstrate value with minimal effort
- Document how to install/enable the hooks on a new machine
- Focus on hooks with high reward-to-effort ratios
- Ensure hooks align with the "spilled coffee" principle (easy to restore after machine loss)

## Potential Hook Ideas
- pre-commit: Check for AWS keys, API tokens, and other sensitive information
- pre-commit: Enforce conventional commit message format
- pre-commit: Run linters on changed files
- pre-push: Run tests before pushing

## Learning Resources
- [Git Hooks Documentation](https://git-scm.com/docs/githooks)
- [Pre-commit Framework](https://pre-commit.com/)
- [AWS Prescriptive Guidance on Git-based Development](https://docs.aws.amazon.com/prescriptive-guidance/latest/choosing-git-branch-approach/best-practices-for-git-based-development.html)

## Success Criteria
- Hooks are stored in the dotfiles repository
- Setup script links hooks to local git repositories
- Documentation explains the purpose of each hook
- Amazon Q can suggest when a particular workflow would benefit from a git hook

Contributor guide

No contributing guide indexed for this repository

Research direction

Inspect the repository layout and existing setup scripts first, then read the Git Hooks Documentation linked in the issue. Define a small set of high-value hooks, store them in the repository, and connect them through the setup script. Done means the hooks can be restored on a new machine and their purposes and installation are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, shell
Domain
documentation, security, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.