Skip to content

docs: add AGENTS.md pointing to the org rules #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matbrgz merged 1 commit into from
Oct 12, 2026
Merged

docs: add AGENTS.md pointing to the org rules #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# AGENTS.md — benchmark-tool

Follow the org-wide rules in [BenchCommons/.github AGENTS.md](https://github.com/BenchCommons/.github/blob/main/AGENTS.md) and the decisions in [.product](https://github.com/BenchCommons/.product). This file only adds what is specific to this repo.

## Role
Tool: builds each catalog implementation in Docker, runs it and records reproducible results. It is derived from the TechEmpower toolset. It owns the **catalog contract** and the **published results format** (see `.product/CONTRACTS.md`).

## Stack and commands
- Python 3.12. `./ssgberk` builds the toolset image and runs `toolset/run-tests.py`.
- `frameworks/` is a submodule pointing to `BenchCommons/catalog-ssg`.
- Results are written to `results/<ts>/results.json` and published under `docs/results/<date>/<suite>/<cell>/`.
- Checks: ruff (py312), pytest, compileall, docker build.
- Specs and their order: `docs/specs/` (see `ROADMAP.md`).

## Rules
- Generalizing beyond SSGs (benchmark-tool#29) and switching to perfratio (#30) are tracked in issues. Do not hard-code new SSG-only assumptions.
Loading