Skip to content

Configure Copilot instructions with project context and documentation hierarchy#58

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/setup-copilot-instructions
Draft

Configure Copilot instructions with project context and documentation hierarchy#58
Copilot wants to merge 2 commits intomainfrom
copilot/setup-copilot-instructions

Conversation

Copy link
Contributor

Copilot AI commented Feb 12, 2026

.github/copilot-instructions.md contained only generic rules with no project context. Enhanced to 220 lines providing immediate context for coding agent sessions.

Structure

Documentation hierarchy established:

  • AGENTS.md → README.md → JUCE_TIPS_AND_TRICKS.md → CODE_REVIEW_FINDINGS.md

Sections added:

  • Tech stack (C++17, JUCE 8.x, CMake, VST3/AU/Standalone)
  • Project structure and module layout
  • Coding guidelines (C++ style, JUCE-specific rules, thread safety patterns)
  • Build/test/deploy commands (./build.sh, pluginval, version management)
  • CI/CD workflow (GitHub Actions, release process)
  • Known issues tracking (resolved ✅ and current ⚠️)
  • Agent best practices (absolute paths, macOS commands)
  • Security requirements (CodeQL, TSan)

Integration Strategy

Instructions reference detailed documentation rather than duplicate:

  • Points to AGENTS.md for comprehensive guidelines
  • Links to JUCE_TIPS_AND_TRICKS.md for framework patterns
  • References CODE_REVIEW_FINDINGS.md for architecture context

This keeps instructions scannable (7.8KB) while providing complete context through documentation hierarchy.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • gh.io
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

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.

Be aware there is an existing agents.md and other plans and documents already in this repo. MAKE SURE you incorporate everything that has already been learned and documented into your context, so you don't repeat mistakes, ignore preferences, or forget lessons learned.

</issue_description>

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


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…ntext

Co-authored-by: mcascone <8335079+mcascone@users.noreply.github.com>
Copilot AI changed the title [WIP] Set up instructions for Copilot in the repository Configure Copilot instructions with project context and documentation hierarchy Feb 12, 2026
Copilot AI requested a review from mcascone February 12, 2026 04: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

2 participants