Skip to content

Foundation: README, AGENTS.md, and docs - #5

Open
edmundmiller wants to merge 6 commits into
mainfrom
port-foundation
Open

Foundation: README, AGENTS.md, and docs#5
edmundmiller wants to merge 6 commits into
mainfrom
port-foundation

Conversation

@edmundmiller

@edmundmiller edmundmiller commented Jun 16, 2026

Copy link
Copy Markdown

Foundation PR for porting edmundmiller/nf-core-skills into nf-core/agents, per the #agents Slack thread.

Keystone of a per-skill PR series. Slimmed per review — agent context only, no tooling.

Included (4 files)

  • README.md — nf-core branding (logo, badges, repository rules) + skills table + install instructions (Claude Code, Codex CLI, OpenCode, Cursor).
  • AGENTS.md — table of contents for agents working in this repo.
  • docs/ARCHITECTURE.md, docs/CONTRIBUTING.md.

Dropped per review (keep the repo slim)

The validation harness (prek.toml, scripts/, tests/, prek CI, .markdownlint.json) was removed — the nf-core/tools lint wrappers are a sync burden that belongs with the tools, not here.

Series

  1. This PR — foundation
  2. nf-core-pipeline skill (Add nf-core-pipeline skill #6)
  3. nf-core-lint skill (Add nf-core-lint skill #7)
  4. nf-core-module skill (Add nf-core-module skill #8)
  5. nf-core-containers skill (Add nf-core-containers skill #9)
  6. agent hook docs (Add agent hook provider docs #10) — closed (documented the removed harness)
  7. plugin manifests (Add multi-harness plugin manifests #11) — optional, under review

Supersedes the split in #3/#4.

🤖 Generated with Claude Code

edmundmiller and others added 2 commits June 16, 2026 09:21
Branded README (logo, badges, repo rules) with skills table + install
instructions, AGENTS.md table of contents, and docs/ (ARCHITECTURE,
CONTRIBUTING). Repo references point at nf-core/agents.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
prek.toml hooks (SKILL.md frontmatter, nf-core lint wrappers, schema
checks), their scripts under scripts/prek-hooks/, the harness unit
tests, and the GitHub Actions workflow that runs prek.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
scripts/agent_hooks/ (provider-agnostic phase/stop runner with Claude,
Codex, Cursor, generic adapters) lives here because the prek harness
tests in tests/prek-hooks/ exercise it. Provider docs ship separately.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@edmundmiller

Copy link
Copy Markdown
Author

Updated: scripts/agent_hooks/ is now included here (the harness tests in tests/prek-hooks/ exercise it, so CI failed without it). The agent hook docs remain in #10.

The harness test hook (tests/prek-hooks/run-tests.py) and the nf-core
lint wrappers run via a `uv run --script` shebang, so the runner needs
uv on PATH or prek fails to spawn the hook (os error 2).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@mashehu mashehu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

waaaaaay too many files.
we want to keep this repo as slim as possible, because it will be a pain to keep in sync with the tools and docs...

Review: keep the repo slim. Remove prek.toml, scripts/ (prek + agent
hooks), tests/, the prek CI workflow, and .markdownlint.json — the
nf-core/tools lint wrappers are a sync burden that belongs with the
tools, not here. Foundation is now just agent context: README,
AGENTS.md, and docs/.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@edmundmiller

Copy link
Copy Markdown
Author

Agreed — slimmed from 36 files to 4. Dropped the whole validation harness (prek.toml, scripts/prek-hooks/ + scripts/agent_hooks/, tests/, the prek CI workflow, .markdownlint.json); the nf-core/tools lint wrappers are exactly the sync burden you flagged and belong with the tools, not here. Foundation is now just agent context: README.md, AGENTS.md, docs/ARCHITECTURE.md, docs/CONTRIBUTING.md.

Knock-on: PR #10 (docs for the now-removed agent-hook runner) is orphaned — I'll close it. PR #11 (Claude/Codex/Cursor plugin manifests + plugins/nf-core-tools/) is the next-heaviest; happy to drop it too if you'd rather installs be docs-only, or trim it to just the marketplace manifests.

🤖 Addressed by Claude Code

@edmundmiller
edmundmiller requested a review from mashehu June 29, 2026 13:10
@edmundmiller edmundmiller changed the title Foundation: scaffolding, docs, and prek validation harness Foundation: README, AGENTS.md, and docs Jun 29, 2026
Comment thread docs/ARCHITECTURE.md Outdated
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

2 participants