Skip to content

docs: add concise AGENTS.md for coverage maintainers - #17

Merged
vitormattos merged 1 commit into
mainfrom
docs/add-agent-guidelines
Nov 8, 2026
Merged

vitormattos merged 1 commit into
mainfrom
docs/add-agent-guidelines

Conversation

@vitormattos

Copy link
Copy Markdown
Member

Purpose

Preserve the architectural and quality decisions already established for LibreSign/coverage so future contributors and coding agents can work without rediscovering them or moving responsibilities back into the PHP application.

Changes

  • Add a single 52-line AGENTS.md at the repository root; no directory-level agent files or duplicate implementation documentation.
  • Explicitly separate LibreSign/libresign (PHP, PHPUnit, Clover/HTML generation) from the publisher (validation, archive, dashboard and Pages).
  • Protect verified main baselines, source-run provenance, immutable archive data, historical Coveralls/Octocov distinctions, and the separation of previews from production measurements.
  • Preserve responsive, accessible dashboard behavior and the existing PHPUnit source-line reports.
  • Record the validation commands and require DCO, cryptographic signatures, and normal PR review.
  • Keep the contributor-facing README short and license-free; link to the existing documentation for details.

Verification

  • python3 -m unittest discover -s tests -q — 52 passed.
  • actionlint .github/workflows/*.yml — passed.
  • node --check for site-theme/*.js, bash -n for scripts/*.sh — passed.
  • Pandoc Markdown rendering, local documentation links, git diff --check — passed.
  • Commit signed via Git Signing MCP with DCO verification.

Scope: documentation only. Does not modify application code, publishing workflows, generated reports, or the live Pages site. Open for regular review; no automatic merge.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
vitormattos merged commit f4912a1 into main Nov 8, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant