Skip to content

Foundation: scaffolding, docs, and prek validation harness#5

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

Foundation: scaffolding, docs, and prek validation harness#5
edmundmiller wants to merge 4 commits into
mainfrom
port-foundation

Conversation

@edmundmiller

Copy link
Copy Markdown

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

This is the keystone of a focused, per-skill PR series. Merge this first so the per-skill PRs are validated by CI.

Included

  • README.md — keeps nf-core branding (logo, badges, repository rules); adds the skills table + install instructions for Claude Code, Codex CLI, OpenCode, Cursor.
  • AGENTS.md — table of contents for agents working in this repo.
  • docs/ARCHITECTURE.md, docs/CONTRIBUTING.md.
  • prek.toml + scripts/prek-hooks/ + tests/prek-hooks/ — SKILL.md frontmatter validation, nf-core lint wrappers, schema checks.
  • .github/workflows/prek.yml — runs prek in CI.
  • .markdownlint.json.

Series (each off main, disjoint files)

  1. This PR — foundation
  2. nf-core-pipeline skill
  3. nf-core-lint skill
  4. nf-core-module skill
  5. nf-core-containers skill
  6. agent hook providers (scripts/agent_hooks/ + docs)
  7. plugin manifests (Claude / Codex / Cursor packaging)

AGENTS.md/docs link to files arriving in later PRs in the series; links resolve as the series merges. Supersedes the content 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>
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