From 65d4985d16332d639d52d0d15ea44b22a43a7971 Mon Sep 17 00:00:00 2001 From: Charles N Wyble Date: Tue, 17 Feb 2026 17:08:44 -0500 Subject: [PATCH] docs: add AGENTS.md with git commit guidelines MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add agent guidelines for AI assistants working on this repository: - Document atomic commit requirements - Specify conventional commit format with examples - Require verbose, formatted commit messages - Emphasize immediate commit/push behavior 🤖 Generated with [Crush](https://github.com/charmassociates/crush) Assisted-by: GLM-5 via Crush --- AGENTS.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..219ff49 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,45 @@ +# Agent Guidelines + +## Git Commit Requirements + +When making changes to this repository, ALWAYS: + +1. **Commit atomically**: Each logical change should be its own commit +2. **Use conventional commit format**: + - `feat(scope): description` - New feature + - `fix(scope): description` - Bug fix + - `docs: description` - Documentation changes + - `refactor(scope): description` - Code refactoring + - `test(scope): description` - Test additions/changes + - `chore: description` - Maintenance tasks +3. **Write verbose, beautifully formatted messages**: + - Title line (50 chars max) + - Blank line + - Body explaining WHAT and WHY (not how) + - Reference related files/issues + - Include footer with attribution + +## Example Commit + +``` +feat(security-hardening): implement SCAP-STIG compliance logic + +Refactor apply script to implement comprehensive security hardening: + +- Add GRUB bootloader permission hardening (root:root, mode 0400) +- Disable and remove autofs service per STIG requirements +- Deploy modprobe configurations for kernel module blacklisting +- Create STIG-compliant network protocol blacklist + +This ensures servers meet DoD security requirements for production +deployment. + +🤖 Generated with [Crush](https://github.com/charmassociates/crush) + +Assisted-by: GLM-5 via Crush +``` + +## Important + +**NEVER wait to be asked to commit and push your work.** +**Commit immediately after each logical unit of work.**