Skip to content

docs: add a minimal AGENTS.md and fix the Shiny link of the README - #317

Merged
Ramdam17 merged 2 commits into
masterfrom
docs/agents-file
Oct 4, 2026
Merged

Ramdam17 merged 2 commits into
masterfrom
docs/agents-file

Conversation

@Ramdam17

@Ramdam17 Ramdam17 commented Oct 4, 2026

Copy link
Copy Markdown
Collaborator

What this does

Adds AGENTS.md at the root of the repository. It is deliberately short and holds only facts that are stable today: how to install the development environment, how to run the tests and what a green run without the optional backends does not cover, the rule that a change to a computed value starts with an independent reference test, and what an agent must not touch (the lock file, the generated docs/requirements.txt, the sample data, the fNIRS and Shiny code, releases). A fuller version will follow once the open questions of method are settled.

The README linked the Shiny dashboards to hypyp/app, which does not exist; they are in hypyp/shiny.

No code changes, so no numerical result changes.

🤖 Generated with Claude Code

AGENTS.md gives coding agents the facts that are stable today: how to
install, how to run the tests and what a green run does not cover, the
reference-test-first rule, and what not to touch. The README pointed to
hypyp/app for the Shiny dashboards, which live in hypyp/shiny.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Code review skipped — your organization has no extra usage available to pay for this review.

If your organization's extra usage balance is empty, an organization admin can add extra usage credits at claude.ai/admin-settings/usage. If its monthly spend limit was reached, an admin can raise it on the same page. If neither applies, contact Anthropic support.

Once extra usage is available, someone with write access to this repository can comment @claude review on this pull request to trigger a review.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@Ramdam17
Ramdam17 merged commit acc6cc2 into master Oct 4, 2026
10 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