E.Noorlander/Collections
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update AGENTS.md with coding standards and commands

Browse Source
This commit is contained in:
Edwin Noorlander 2025-11-11 18:17:54 +01:00
parent 3ff85b8143
commit c1957baab9
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
AGENTS.md
View File

@ -1,27 +1,27 @@
# AGENT CODING STANDARDS # AGENT CODING STANDARDS
This project is a PHP MVC application using Composer, Twig, and FastRoute, running in an LXC container. This project is a PHP MVC application using Composer, Twig, FastRoute, and SQLite in an LXC container.
## 🛠️ Development Commands ## 🛠️ Development Commands
| Type | Command | Notes | - **Dependencies:** `composer install` / `update` (updates after editing composer.json)
| :--- | :--- | :--- | - **Linting:** N/A (adhere to PSR-12 manually)
| **Dependencies** | `incus exec www composer install` / `incus exec www composer update` | Run from the host machine. Apache2 with PHP/Composer runs in the INCUS container 'www'. The folder ./ is shared with /var/www/localhost/ in the container, and port 80 is shared with the host. Use `update` after editing `composer.json`. | - **Testing:** `curl localhost` (no framework; run manual scripts like `php test.php` for single tests)
| **Linting** | N/A | No dedicated tool. Adhere to PSR-12 standards. | - **Build:** N/A (direct PHP execution)
| **Testing** | `curl localhost` | No testing framework configured. Avoid adding tests until one is introduced. | - **Version Control:** `git status` / `add` / `commit` / `push`
## 📐 Code Style & Conventions ## 📐 Code Style & Conventions
1. **Architecture:** Strict MVC pattern. Logic in `src/Controllers`, data access in `src/Models`, views in `templates/`. 1. **Architecture:** MVC pattern (Controllers in `src/Controllers/`, Models in `src/Models/`, Views in `templates/`)
2. **Namespacing:** Use `App\` as the base namespace (PSR-4). 2. **Namespacing:** PSR-4 with `App\` base
3. **Naming:** Classes are `PascalCase`. Functions, methods, and variables are `camelCase`. 3. **Naming:** Classes `PascalCase`, methods/variables `camelCase`
4. **Templating:** Use **Twig** (`.twig`). All HTML rendering must be done via Twig. 4. **Templating:** Twig only (`.twig` files)
5. **I18n:** All user-facing strings must use `App\Services\TranslationService` (PHP) or `{{ trans('ID') }}` (Twig). 5. **I18n:** Use `App\Services\TranslationService` (PHP) or `{{ trans('ID') }}` (Twig)
6. **Error Handling:** Use PHP's native exception handling (`try/catch`). Log critical errors with `error_log()`. 6. **Error Handling:** `try/catch` blocks; log with `error_log()`
7. **Database:** Access SQLite via `App\Database\Database::getInstance()`. **Do not** use direct `new PDO()`. 7. **Database:** Use `App\Database\Database::getInstance()` (no direct PDO)
8. **Imports:** Use fully qualified class names or `use` statements at the top of the file. 8. **Imports:** `use` statements at top or fully qualified names
9. **Security:** Never introduce code that exposes or logs secrets and keys. Never commit secrets or keys to the repository. 9. **Security:** No secrets/keys exposure or logging
10. **Types:** Use type hints for function parameters and return types where possible. 10. **Types:** Type hints on params/returns where possible
11. **Formatting:** Follow PSR-12 standards for code formatting. 11. **Formatting:** PSR-12
12. **Comments:** Do not add comments unless explicitly requested. 12. **Comments:** Avoid unless requested
13. **Libraries:** Only use libraries already in composer.json. Check composer.json before adding new dependencies. 13. **Libraries:** Check composer.json before adding