This AGENTS.md file provides guidelines for OpenAI Codex and other AI agents interacting with this codebase, including which directories are safe to read from or write to.
| Directory | Description | Agent Action |
|---|---|---|
/vendor |
External plugins; may help understand data sources. | Do not modify |
/l10n |
Translation files from Transifex. | Do not modify |
/js/3rdParty |
Third-party JavaScript plugins. | Do not modify |
/css/3rdParty |
Third-party CSS plugins. | Do not modify |
/sample_data |
Example data for human reference. | Irrelevant to agents |
/screenshots |
UI images for documentation purposes. | Irrelevant to agents |
/tests |
phpUnit and SeleniumIDE test cases | use if possible |
Agents should focus on the core application logic and ignore files or folders marked as third-party, sample, or media-related. All changes should preserve the integrity of external dependencies and translations.
For every change, add a meaningful one-liner to the corresponding section (Added, Changed, Fixed) in CHANGELOG.md.
Test execution instructions are maintained in tests/INSTRUCTIONS.md; prefer the reusable wrappers tests/run-unit.sh and tests/run-playwright.sh over ad-hoc container commands.
No nodejs or vue components are used. Everything is plain Javascript.
Do not use ILogger. It is deprecated in favor of Psr\Log\LoggerInterface
Every new file needs to get a SPDX header in the first rows according to this template. The year in the first line must be replaced with the year when the file is created (for example, 2026 for files first added in 2026). The commenting signs need to be used depending on the file type. If a file can not get a header like svg images, these need to be added to the REUSE.toml file.
SPDX-FileCopyrightText: <YEAR> Marcel Scherello
SPDX-License-Identifier: AGPL-3.0-or-later