Skip to content

Add AGENTS.md for coding agent onboarding#390

Merged
RemiLehe merged 9 commits into
mainfrom
copilot/add-copilot-instructions
Mar 26, 2026
Merged

Add AGENTS.md for coding agent onboarding#390
RemiLehe merged 9 commits into
mainfrom
copilot/add-copilot-instructions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 23, 2026

  • Explore repository structure, build system, dependencies, and workflows
  • Understand project architecture (dashboard, ML, Docker containers)
  • Review existing documentation (README.md, dashboard/README.md, ml/README.md)
  • Verify linting setup and run linter (ruff check passes cleanly)
  • Create .github/copilot-instructions.md with comprehensive agent onboarding instructions
  • Run code review (no issues found)
  • Run CodeQL checker (no code changes to analyze — Markdown only)
  • Address review feedback: remove Ruff version, format pip as inline code, remove MongoDB from NERSC services list
  • Address review feedback: remove MLflow item from ML Training section (not yet set up in main)

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: EZoni <59625522+EZoni@users.noreply.github.com>
Copilot AI changed the title [WIP] Add onboarding instructions for Copilot coding agent Add .github/copilot-instructions.md for coding agent onboarding Feb 23, 2026
Copilot AI requested a review from EZoni February 23, 2026 22:36
@EZoni
Copy link
Copy Markdown
Member

EZoni commented Feb 23, 2026

@RemiLehe

The instructions in this PR were created automatically by GitHub Copilot following the instructions at https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions#creating-repository-wide-custom-instructions, using Claude Opus 4.6.

I have not reviewed the PR yet, but I think it could be interesting to compare the instructions added in this PR with the ones you added in #384, even though they may be serving different purposes.

@RemiLehe
Copy link
Copy Markdown
Contributor

Yes, I fully agree.
Btw, do you know whether Copilot automatically read the AGENTS.md it finds in the root of the repository? (i.e. the one added in #384 )

@EZoni
Copy link
Copy Markdown
Member

EZoni commented Feb 23, 2026

Yes, I fully agree. Btw, do you know whether Copilot automatically read the AGENTS.md it finds in the root of the repository? (i.e. the one added in #384 )

Yes, I think so. It's what they call "agent instructions" at https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions#creating-custom-instructions, while the instructions added here is what they call "repository-wide custom instructions", which I think are used for, e.g., code reviews:

Screenshot from 2026-02-23 14-49-57

Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
…move MongoDB from NERSC services

Co-authored-by: EZoni <59625522+EZoni@users.noreply.github.com>
Copilot AI requested a review from EZoni February 24, 2026 18:44
Comment thread .github/copilot-instructions.md Outdated
…p in main

Co-authored-by: EZoni <59625522+EZoni@users.noreply.github.com>
Copilot AI requested a review from EZoni February 24, 2026 18:47
@EZoni EZoni requested a review from RemiLehe February 24, 2026 18:50
@EZoni EZoni marked this pull request as ready for review February 24, 2026 18:53
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
EZoni and others added 2 commits March 25, 2026 13:20
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
@EZoni EZoni force-pushed the copilot/add-copilot-instructions branch from 51ae05f to bf96e0d Compare March 25, 2026 20:35
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
Copilot AI requested a review from EZoni March 25, 2026 20:42
Comment thread AGENTS.md Outdated
@RemiLehe RemiLehe changed the title Add .github/copilot-instructions.md for coding agent onboarding Add AGENTS.md for coding agent onboarding Mar 26, 2026
@RemiLehe RemiLehe merged commit 2ed4d65 into main Mar 26, 2026
1 check passed
@RemiLehe RemiLehe deleted the copilot/add-copilot-instructions branch March 26, 2026 23:14
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