Add .github/copilot-instructions.md for agent onboarding#5
Draft
Copilot wants to merge 3 commits into
Draft
Conversation
Co-authored-by: igor-holt <125706350+igor-holt@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add Copilot agent onboarding instructions
Add .github/copilot-instructions.md for agent onboarding
Nov 13, 2025
Updated the purpose statement to remove 'Defense-only' and clarified the repository's focus.
Igor Holt (igor-holt)
approved these changes
Nov 13, 2025
Igor Holt (igor-holt)
approved these changes
Nov 13, 2025
Igor Holt (igor-holt)
approved these changes
Nov 13, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Creates comprehensive onboarding documentation for GitHub Copilot agents to reduce build failures and minimize exploration time. All commands verified from clean checkout.
Repository Context
Setup & Build Workflows
python -m src.main(displays pipeline status)integration,heavy,gpu,slow)CI/CD Documentation
Local CI simulation commands provided to mirror GitHub Actions behavior.
Known Issues Documented
charset-normalizertransitive dependency--no-depsflagProject Structure
Agent Guidance
.copilot/AGENT_GUIDE.md+ task definitions before changesSECURITY.mdbefore all changesFile includes common issues/solutions, environment variables, quick reference commands, and emphasizes trusting instructions over exploration.
Original prompt
Your task is to “onboard” this repository to the Copilot coding agent by creating a file:
.github/copilot-instructions.md
This file is for a coding agent seeing the repo for the first time. It should explain how to work efficiently in this repo, reduce build/validation failures, and minimize aimless exploration. You will do this once per repository. Take your time, think carefully, and search thoroughly before writing.
- Reduce the chance that an agent’s pull request is rejected due to: - Failing CI builds or validation pipelines. - Misbehavior, incorrect assumptions, or misuse of tools. - Minimize bash command and build failures. - Let the agent complete tasks faster by reducing the need for grep/find/search or trial-and-error command runs. - .github/copilot-instructions.md must be no longer than about 2 pages of text. - Instructions must describe how to work in this repo in general and must NOT be task-specific. In the instructions file, add the following high-level details so the agent can understand the repo without re-discovering them each time:- A concise summary of what the repository does and its primary domain.
- High-level repository information:
- Approximate size or complexity (for example: mono-repo vs. small service).
- Project type(s) (for example: web service, CLI tools, infrastructure-as-code, ML, etc.).
- Languages, frameworks, and runtimes in use (for example: Python, Node.js, Go, Docker, Terraform, Kubernetes).
- Any notable external services (for example: cloud providers, databases, message queues).
Document how to set up, build, test, run, and validate changes so the agent does NOT have to rediscover these each time.For each of the following, clearly document:
For each step:
While exploring:
- Try running commands in different orders; record errors, timeouts, and misbehavior and how you resolved them.
- Make at least one small code change; document any unexpected build/test issues and the workarounds.
- Document environment setup steps that appear “optional” but you confirm are actually required.
- When you discover a sequence that consistently works for a particular purpose, write it down exactly and clearly mark it as the recommended sequence.
Document the layout and architecture so the agent can quickly find where to make changes:- Describe the major architectural components and their locations, for example:
- entrypoints, main services, CLIs, libraries
- core modules vs. support or experimental code
- List the relative paths to:
- Main project files and entrypoints.
- Configuration for build/test/lint/format tools (for example: package.json, pyproject.toml, Makefile, Dockerfile, .github/workflows/, .eslintrc.*, .prettierrc, .flake8, etc.).
- Infrastructure and deployment config (for example: Terraform, Helm charts, Kubernetes manifests, Docker Compose).
- Describe checks that run before merge:
- GitHub Actions workflows (filenames and a short description of what each does).
- Any external CI, validation, or deployment pipelines.
- Steps the agent can run locally to closely mirror CI behavior.
- Mention dependencies that aren’t obvious from layout (for example: tools installed via system package managers, language-specific global tools, pre-commit hooks).
- If space remains, use it to reduce agent exploration:
- List the files in the repo root and briefly describe their roles.
- Summarize the README contents.
- Call out key source files and directories (for example: files containing main methods, router definitions, core business logic).
- Include small, representative code snippets when they help the agent recognize patterns.
When preparing .github/copilot-instructions.md, follow these steps:💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.