Skip to content

docs: add comprehensive .github/copilot-instructions.md with build, test, and validation guidance#534

Closed
Copilot wants to merge 1 commit intomainfrom
copilot/fix-c8b4036a-84db-4cc3-be72-d2a87f887ca8
Closed

docs: add comprehensive .github/copilot-instructions.md with build, test, and validation guidance#534
Copilot wants to merge 1 commit intomainfrom
copilot/fix-c8b4036a-84db-4cc3-be72-d2a87f887ca8

Conversation

Copy link
Contributor

Copilot AI commented Aug 26, 2025

This PR adds comprehensive instructions for GitHub Copilot coding agents to work efficiently with the impvol repository. The instructions are designed to minimize exploration time, reduce build failures, and improve the quality of agent-generated pull requests.

What's Added

A detailed .github/copilot-instructions.md file that provides:

Repository Overview

  • Clear description of impvol's purpose as an importable volume for virtual filesystems
  • Technology stack details: TypeScript/Node.js v20+, dual ESM/CJS package built with tshy
  • Key dependencies and memory considerations (worker thread limitations)

Build & Validation Workflow

  • Complete command sequences with timing estimates for all operations
  • Critical setup requirements including the --foreground-scripts flag for npm ci
  • Comprehensive validation commands: build, test, lint, type-check, markdown, spelling, unused code detection
  • Build artifact management and clean build procedures

Project Architecture

  • Source code layout with detailed descriptions of key files and their purposes
  • Configuration files documentation for TypeScript, ESLint, Prettier, and other tools
  • CI/CD workflows covering all 13 GitHub Actions workflows and their purposes
  • Git hooks and code quality setup with husky, lint-staged, and commitlint

Agent Guidelines

  • Validated command sequences that have been tested end-to-end
  • Common failure patterns and how to avoid them (e.g., running tsc directly vs npm run tsc)
  • Trust-first approach to minimize unnecessary exploration

Validation

All instructions have been thoroughly tested by:

  • Running complete clean environment setup from scratch
  • Executing all documented command sequences successfully
  • Verifying all linting rules pass (markdown, spelling, formatting)
  • Testing failure scenarios to validate warnings and troubleshooting guidance

The instructions follow the repository's existing standards and pass all validation checks, ensuring they integrate seamlessly with the existing development workflow.

This should significantly improve the efficiency and success rate of future Copilot agent contributions to the repository.


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

@boneskull boneskull closed this Aug 26, 2025
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... docs: add comprehensive .github/copilot-instructions.md with build, test, and validation guidance Aug 26, 2025
Copilot AI requested a review from boneskull August 26, 2025 20:36
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