Skip to content

chore: developer experience - pre-commit hook, ai instructions, yaml formatting#374

Merged
feschber merged 4 commits intofeschber:mainfrom
jonstelly:pr/dx-and-ai
Mar 25, 2026
Merged

chore: developer experience - pre-commit hook, ai instructions, yaml formatting#374
feschber merged 4 commits intofeschber:mainfrom
jonstelly:pr/dx-and-ai

Conversation

@jonstelly
Copy link
Contributor

@jonstelly jonstelly commented Feb 4, 2026

Some minor developer experience items:

  • pre-commit hook to run cargo fmt, clippy, test
  • README.md addition for registering the git hook
  • editorconfig for formatting, mainly for toml, yaml, but tried to replicate rustfmt.toml reasonably
  • AGENTS.md - copilot instructions/help for the repository, aiming to constrain/focus copilot a bit, give a bit of context of terminology, code-base

@jonstelly jonstelly marked this pull request as ready for review February 13, 2026 18:21
Copilot AI review requested due to automatic review settings February 13, 2026 18:21
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@feschber
Copy link
Owner

Maybe we should move the development instruction from the README to a CONTRIBUTING.md

@feschber feschber merged commit 4d8f7d7 into feschber:main Mar 25, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants