From 347c0330b19dd5318a25aac2f26a3961decfab6c Mon Sep 17 00:00:00 2001 From: Dan Jones Date: Sun, 16 Nov 2025 19:39:05 -0600 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20AGENTS.md=20with=20agent?= =?UTF-8?q?=20guidelines?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..1e4712b --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,30 @@ +# Agent Guidelines for vid-queue + +This document outlines the conventions and commands for agentic coding in this repository. + +## Build/Lint/Test Commands + +* **Run all tests:** `php artisan test` or `php ./vendor/bin/pest` +* **Run a single test file:** `php artisan test ` (e.g., `php artisan test tests/Feature/Commands/GetShowTest.php`) +* **Linting:** Adhere to PSR-12 coding standards. No explicit linting command is configured, but static analysis tools like PHPStan or Psalm may be used locally. + +## Code Style Guidelines + +* **Imports:** Use fully qualified class names and `use` statements at the top of files. +* **Formatting:** + * Indent with 4 spaces. + * Use `lf` for line endings. + * Ensure a final newline at the end of files. + * Trim trailing whitespace. +* **Types:** Utilize PHP 7.4+ type hints for arguments, return types, and properties where appropriate. +* **Naming Conventions:** + * Classes: PascalCase (e.g., `GetShow`, `TraktLogin`). + * Methods/Functions: camelCase. + * Variables: camelCase. +* **Error Handling:** Use exceptions for error handling. +* **Dependency Injection:** Prefer dependency injection over using Facades or resolving from the IOC Container directly. + +## Git Commit Guidelines +- **Format**: Prepend commit messages with a gitmoji emoji (see https://gitmoji.dev) +- **Style**: Write detailed commit messages that explain what changed and why +- **Examples**: `✨ Add JSON export functionality for log entries`, `🐛 Fix date parsing for RFC3339 timestamps`, `📝 Update README with configuration examples`