Skip to content

Add AGENTS.md file and the related template feature#4318

Draft
itrujnara wants to merge 7 commits into
nf-core:devfrom
itrujnara:add_agents_md
Draft

Add AGENTS.md file and the related template feature#4318
itrujnara wants to merge 7 commits into
nf-core:devfrom
itrujnara:add_agents_md

Conversation

@itrujnara

Copy link
Copy Markdown
Contributor

This PR adds AGENTS.md to the pipeline template. This is currently intended as a place to discuss the draft of the file. Please DO NOT MERGE until the file has been manually tested in a few pipelines.

PR checklist

  • This comment contains a description of changes (with reason)
  • CHANGELOG.md is updated
  • If you've fixed a bug or added code that should be tested, add tests!
  • Documentation in docs is updated

@codecov

codecov Bot commented Jun 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.07%. Comparing base (db5e3bb) to head (24113e9).
⚠️ Report is 42 commits behind head on dev.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@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.

before we add this, I would like to see it in several pipelines. To check that everything works as expected

@itrujnara

Copy link
Copy Markdown
Contributor Author

@mashehu sure, that is the plan in the RFC. I have opened this as draft so that people can leave comments on the file and/or copy it to pipelines.

ewels
ewels previously requested changes Jun 9, 2026

@ewels ewels left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please also include in the pipeline lint test files_unchanged: https://nf-co.re/docs/nf-core-tools/api_reference/4.0.2/pipeline_lint_tests/files_unchanged

Comment thread nf_core/pipeline-template/AGENTS.md Outdated
Also removed pipeline-specific section boilerplate to avoid lint issues
@itrujnara

Copy link
Copy Markdown
Contributor Author

Lint test added, can someone help with the CI errors?

@mashehu

mashehu commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

you need to update the snapshots. for the test_create_app, I can give it a try. the other one is a simple nf-test snapshot of pipeline created with just that feature

Comment thread nf_core/pipelines/create/template_features.yml Outdated
Co-authored-by: Matthias Hörtenhuber <mashehu@users.noreply.github.com>
@itrujnara

Copy link
Copy Markdown
Contributor Author

@nf-core-bot update snapshots

@ewels ewels dismissed their stale review June 26, 2026 07:52

Resolved

Comment thread nf_core/pipeline-template/AGENTS.md Outdated
Co-authored-by: Phil Ewels <phil.ewels@seqera.io>
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.

3 participants