Conversation
✅ Deploy Preview for nf-core-main-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
mashehu
left a comment
mashehu
left a comment
There was a problem hiding this comment.
can't we just symlink this to contributing.md? All this information is there already and we don't need to remember to keep things in sync
|
You mean That file is mostly about how to add yourself to the list of contributors, and how to fork the repo and make PRs. None of that is relevant to an LLM that will already be checked out on a branch with a task to do (actually it'll make its performance actively worse). It doesn't include any information about the build architecture, testing, Astro setup etc (arguably most Human contributors don't need to know any of this, as they can just edit a markdown file and see the deployment preview). |
|
Side note: playing around with how to get Claude to read
I think this should get Claude to automatically read |
|
Ah, sorry, was thinking of the wrong repo. For the website the readme has the same instructions as the agents.md |
|
That's closer, but it still doesn't mention tests etc. and is 300+ lines instead of 30. Also it's not automatically loaded into context like this file. This isn't that much to keep updated is it? Would be a good addition to this file to say read the |
|
|
||
| This file provides guidance to AI coding agents (Claude Code and others) when working with code in this repository. | ||
|
|
||
| The source for **https://nf-co.re** — the nf-core community website. Built with **Astro** (static site generation), **Svelte** (interactive components) and **Bootstrap** (CSS), managed as **npm workspaces** with **Node 22**. |
There was a problem hiding this comment.
| The source for **https://nf-co.re** — the nf-core community website. Built with **Astro** (static site generation), **Svelte** (interactive components) and **Bootstrap** (CSS), managed as **npm workspaces** with **Node 22**. | |
| The source for **https://nf-co.re** — the nf-core community website. Built with **Astro 6** (static site generation), **Svelte 5** (interactive components) and **Bootstrap 5.3** (CSS), managed as **npm workspaces** with **Node 22**. |
if you mention one version, we should mention all, especially because in my experience it keeps producing outdated syntax for svelte. pain to keep updated though
|
|
||
| Tests are **Playwright** (`npm run test --workspace sites/<name>`, or `npx playwright test <file>` within a sub-site for a single test). | ||
|
|
||
| **GitHub token:** the data-driven sub-sites (`pipelines`, `pipeline-results`, `configs`, `modules-subworkflows`, `stickers`) hit the GitHub API during the build. Add a `.env` at the repo root with a `GITHUB_TOKEN` (a personal access token with `public_repo` scope) to avoid rate limits. |
There was a problem hiding this comment.
i don't think it can add a correct github_token automatically...
2 participants
Minimal
AGENTS.md, added after asking Claude to debug phantom CORS errors. Hopefully helps sessions get going a bit faster.