Racktopia Shared Development Tools

This repository contains shared pre-commit hooks, setup scripts, and development tools used across all Racktopia projects.

Documentation

📖 Pre-commit Setup & Usage

Complete guide to installing, configuring, and using pre-commit hooks with racktopia shared tooling.

📖 Hooks Documentation

Detailed reference for all available hooks, their purposes, dependencies, and troubleshooting.

Quick Start

1. Install pre-commit (one-time per machine)

pip install pre-commit
# or: brew install pre-commit

See docs/pre-commit.md for other installation methods.

2. Install hooks (one-time per repo)

pre-commit install

3. Start coding!
Hooks run automatically and check dependencies as needed.

Repository Contents

• .markdownlint.json - Shared markdown linting rules
• .pre-commit-hooks.yaml - Hook definitions for other repositories to consume
• hooks/ - Custom hook scripts for complex validation
• docs/ - Comprehensive documentation for setup and usage

Development Notes

When adding new hooks or modifying existing ones:

1. Update hook scripts in hooks/ directory
2. Update hook definitions in .pre-commit-hooks.yaml
3. Update documentation in docs/hooks.md
4. Test thoroughly across different repository types
5. Follow the alphabetical ordering convention (except racktopia-standards first)