vid-queue/AGENTS.md

Agent Guidelines for vid-queue

This document outlines the conventions and commands for agentic coding in this repository.

Build/Lint/Test Commands

• Tests: There are no working tests. The user will do manual tests.
• 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