Skip to content

feat: add comprehensive Copilot instructions for repository onboarding#537

Merged
boneskull merged 2 commits intomainfrom
copilot/fix-8db28304-2340-4390-ab4f-e48c131d80cd
Sep 11, 2025
Merged

feat: add comprehensive Copilot instructions for repository onboarding#537
boneskull merged 2 commits intomainfrom
copilot/fix-8db28304-2340-4390-ab4f-e48c131d80cd

Conversation

Copy link
Contributor

Copilot AI commented Aug 26, 2025

Adds .github/copilot-instructions.md to onboard the repository for GitHub Copilot coding agents. This comprehensive guide provides everything a coding agent needs to work efficiently with the impvol codebase without extensive exploration.

What's Included

Repository Overview: Complete description of impvol as an "Importable Volume" library that enables importing scripts and modules from memfs virtual filesystems using Node.js customization hooks.

Verified Build & Validation Instructions:

  • Environment setup sequence: npm installnpm run build
  • Testing with Node.js built-in test runner and tsx
  • Complete linting pipeline (ESLint, knip, markdown, spelling, TypeScript)
  • Formatting with Prettier
  • Full validation sequence that matches CI requirements

Project Architecture & Layout:

  • Source structure (6 TypeScript files in src/)
  • Dual ESM/CJS build outputs via tshy
  • Configuration files and their purposes
  • Git hooks setup (Husky + lint-staged)

CI/CD Documentation: All 13 GitHub Actions workflows documented with their exact commands and purposes, including build/test matrix across Node.js versions and operating systems.

Dependencies & Architecture Details:

  • Node.js 20.0.0+ requirement
  • memfs peer dependency usage
  • Worker thread architecture with known memory leaks (documented feature)
  • Custom impvol:// protocol implementation

Common Issues & Workarounds: Documented solutions for typical build sequence issues, dual package considerations, and expected behaviors like memory leaks.

File Location Reference: Complete directory structure for easy navigation without exploration.

Validation

All commands documented in the instructions have been tested and verified to work correctly. The complete validation sequence passes all checks:

npm install && npm run build && npm run lint && npm run lint:knip && npm run lint:md && npm run lint:spelling && npm run tsc && npm test && npm run format -- --list-different

This file significantly reduces the time coding agents need to understand the repository structure and eliminates common build/test failures by providing precise, verified instructions.


💡 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.

Copilot AI changed the title [WIP] Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently. You wi... feat: add comprehensive Copilot instructions for repository onboarding Aug 26, 2025
Copilot AI requested a review from boneskull August 26, 2025 20:40
@boneskull boneskull marked this pull request as ready for review September 11, 2025 18:07
@boneskull boneskull merged commit 839daf9 into main Sep 11, 2025
27 of 29 checks passed
@boneskull boneskull deleted the copilot/fix-8db28304-2340-4390-ab4f-e48c131d80cd branch September 11, 2025 18:07
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.

2 participants