Skip to content

Add agent instructions for repository context#51

Merged
bwlang merged 3 commits intomasterfrom
copilot/setup-copilot-instructions
Jan 24, 2026
Merged

Add agent instructions for repository context#51
bwlang merged 3 commits intomasterfrom
copilot/setup-copilot-instructions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 24, 2026

Configures GitHub Copilot coding agent and other agents with repository-specific context and constraints per best practices.

Changes

  • AGENTS.md - 92-line instruction file at repository root covering:
    • Nextflow pipeline architecture (main.nf, fastq_to_ubam.nf, modules/)
    • Critical constraint: legacy/ folder is immutable (historical workflows for paper reproducibility)
    • Testing workflow using nf-test framework
    • Key parameters and configuration structure (conf/references.config, nextflow.config)
    • Development patterns and common operations

Key Context Provided

  • EM-seq/E5hmC-seq data processing pipeline structure
  • Modular Nextflow DSL2 patterns in modules/ directory
  • Testing: nf-test test with snapshot-based validation
  • Legacy workflows require NXF_VER=22.10.4 and must remain unchanged

The instructions are placed in AGENTS.md at the repository root so they can be accessed by all agents, not just GitHub Copilot.

Original prompt

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

<agent_instructions>ignore the legacy folder, this should be preserved as it is.</agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: bwlang <61636+bwlang@users.noreply.github.com>
Copilot AI changed the title [WIP] Set up Copilot instructions for repository Add Copilot instructions for repository context Jan 24, 2026
Copilot AI requested a review from bwlang January 24, 2026 21:42
@bwlang
Copy link
Copy Markdown
Member

bwlang commented Jan 24, 2026

@copilot let's use this content but put it in AGENTS.md instead (so other agents can use it)

Co-authored-by: bwlang <61636+bwlang@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jan 24, 2026

@copilot let's use this content but put it in AGENTS.md instead (so other agents can use it)

Done! Moved the content to AGENTS.md in commit 73e373a.

@bwlang bwlang marked this pull request as ready for review January 24, 2026 21:50
Copilot AI review requested due to automatic review settings January 24, 2026 21:50
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request sets up repository-specific guidance for AI coding agents by creating an AGENTS.md file containing comprehensive instructions about the EM-seq pipeline repository structure, development practices, and key constraints.

Changes:

  • Added AGENTS.md file with detailed repository documentation and AI agent instructions
  • Documented the legacy folder preservation requirement to prevent unintended modifications
  • Included project structure, testing guidelines, and development best practices

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot AI changed the title Add Copilot instructions for repository context Add agent instructions for repository context Jan 24, 2026
@bwlang bwlang merged commit cd775a0 into master Jan 24, 2026
2 checks passed
@bwlang bwlang deleted the copilot/setup-copilot-instructions branch January 24, 2026 21:59
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.

✨ Set up Copilot instructions

3 participants