Guest User

nf-core AGENTS check example

a guest
Jun 17th, 2026
14
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 3.61 KB | None | 0 0
  1. User: Read this file: https://raw.githubusercontent.com/nf-core/agents/refs/heads/add-agents-md/AGENTS.md. Confirm that you have the file and that you can read it.
  2.  
  3. GitHub Copilot: I’ll fetch that AGENTS.md URL now and confirm I can read its contents.
  4.  
  5. Fetched https://raw.githubusercontent.com/nf-core/agents/refs/heads/add-agents-md/AGENTS.md
  6.  
  7. Confirmed. I successfully fetched that file and can read it.
  8.  
  9. I can access:
  10. - https://raw.githubusercontent.com/nf-core/agents/refs/heads/add-agents-md/AGENTS.md
  11.  
  12. I also parsed substantive content from it (sections like “Nextflow pitfalls”, “nf-core template structure”, “nf-test and testing”, and “git and branch policy”), so read access is working.
  13.  
  14. User: Great. Quiz time. I ask, you answer, no coding needed. Question 1: Under what circumstances can you write code to the TEMPLATE branch?
  15.  
  16. GitHub Copilot: Never. You cannot write code to the TEMPLATE branch under any circumstances; it is explicitly managed by nf-core tools and must not be written to directly.
  17.  
  18. User: How many approvals are required to merge a PR to the main branch?
  19.  
  20. GitHub Copilot: Two approvals are required to merge a PR to the `main` branch.
  21.  
  22. User: Which keyword do you use to define a variable in Nextflow?
  23.  
  24. GitHub Copilot: Use `def` to define a variable in Nextflow.
  25.  
  26. User: I need to find the output file paths for a module called STRELKA in a pipeline with legacy outputs. Where should I look for it?
  27.  
  28. GitHub Copilot: For legacy outputs, check the places where `publishDir` is defined for that process.
  29.  
  30. Start here:
  31. 1. The STRELKA module process definition itself (its process block often contains `publishDir`).
  32. 2. The central process configuration overrides for modules (where `withName` selectors can set or override `publishDir` for STRELKA).
  33.  
  34. In short: find the `publishDir` attached to STRELKA, because in legacy-output pipelines that is what determines the final output paths.
  35.  
  36. User: Suppose you want to add a new tool to the pipeline. Which steps would you take and which files could be affected?
  37.  
  38. GitHub Copilot: 1. Decide integration strategy first:
  39. - Reuse an existing nf-core module if possible.
  40. - If no suitable reusable module exists, create a local module with nf-core tools.
  41.  
  42. 2. Add the module or subworkflow with nf-core tooling:
  43. - Install/create with nf-core commands rather than hand-crafting boilerplate.
  44. - If you must adjust an nf-core module implementation, patch it afterwards with nf-core modules patch.
  45.  
  46. 3. Wire the tool into pipeline execution:
  47. - Connect inputs/outputs in the main workflow graph in nf-amplivar.nf and, if needed, orchestration in main.nf.
  48. - Keep output style consistent with the pipeline’s existing output system (legacy publishDir vs workflow outputs).
  49.  
  50. 4. Configure runtime options and resources:
  51. - Add module-specific settings (for example ext.args/ext.prefix, resources) in modules.config.
  52. - Update global/default params if needed in nextflow.config and profile-specific configs such as test.config or test_full.config.
  53.  
  54. 5. Expose and validate new parameters:
  55. - Extend the schema in nextflow_schema.json.
  56. - If input format changes are needed, update schema_input.json.
  57.  
  58. 6. Add or update tests:
  59. - Add/update pipeline-level tests in default.nf.test and test config in nextflow.config.
  60. - Add/update module tests in the corresponding module test area under the modules directory.
  61.  
  62. 7. Update documentation:
  63. - Document usage/params/outputs in README.md.
  64.  
  65. Most commonly affected files in this repository are:
  66. - nf-amplivar.nf
  67. - main.nf
  68. - modules.config
  69. - nextflow.config
  70. - nextflow_schema.json
  71. - default.nf.test
  72. - nextflow.config
  73. - README.md
Advertisement
Add Comment
Please, Sign In to add comment