chore: developer experience - pre-commit hook, ai instructions, yaml formatting#374
Merged
feschber merged 4 commits intofeschber:mainfrom Mar 25, 2026
Merged
chore: developer experience - pre-commit hook, ai instructions, yaml formatting#374feschber merged 4 commits intofeschber:mainfrom
feschber merged 4 commits intofeschber:mainfrom
Conversation
jonstelly
commented
Feb 6, 2026
jonstelly
commented
Feb 6, 2026
ff2ac4f to
71a6777
Compare
There was a problem hiding this comment.
Pull request overview
This PR enhances developer experience by adding tooling and documentation to support consistent code quality and provide guidance for AI-assisted development. The changes introduce a pre-commit hook for automated quality checks, an editorconfig for consistent formatting across file types, and comprehensive agent instructions for GitHub Copilot.
Changes:
- Added pre-commit hook script that runs formatting, linting, and tests before commits
- Created AGENTS.md with architecture overview, terminology, conventions, and workflow guidance for AI assistants
- Added .editorconfig for consistent editor settings across Rust, YAML, TOML, and Nix files
- Updated README.md with instructions for enabling the git hook and reorganized development section
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| README.md | Added "Development" section with git hook setup instructions and reorganized existing installation content |
| AGENTS.md | New file providing comprehensive agent instructions including architecture, terminology, async patterns, and development workflow |
| .githooks/pre-commit | New pre-commit hook script that runs cargo fmt, clippy, and test before allowing commits |
| .editorconfig | New editorconfig file defining formatting standards for Rust (4 spaces), YAML (2 spaces), TOML (4 spaces), and Nix (2 spaces) files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
6295707 to
9f07ef0
Compare
Owner
|
Maybe we should move the development instruction from the README to a CONTRIBUTING.md |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Some minor developer experience items: