Skip to content

Add Copilot coding agent onboarding documentation#8508

Merged
Jason3S merged 2 commits into
mainfrom
copilot/add-copilot-instructions-file
Feb 3, 2026
Merged

Add Copilot coding agent onboarding documentation#8508
Jason3S merged 2 commits into
mainfrom
copilot/add-copilot-instructions-file

Conversation

Copilot AI commented Feb 3, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Creates .github/copilot-instructions.md to provide coding agents with essential repository context on first encounter.

Contents

Development Setup

  • Prerequisites: Node 20+, pnpm 10.27+, corepack enablement
  • Build system: TypeScript, tsdown, rollup (dual ESM/CJS output)
  • Testing: vitest (primary), jest (legacy)
  • Linting: ESLint flat config, Prettier

Monorepo Architecture

  • pnpm workspaces with ~30 packages
  • Internal dependencies via workspace:* notation
  • Build concurrency limited to 2 jobs (prevents race conditions)

Common Errors & Workarounds

  • Corepack/pnpm version mismatches
  • Module resolution failures after package changes
  • Snapshot update procedures
  • Git diff validation issues (CI requirement)
  • Windows-specific build problems (line endings, path separators)
  • TypeScript isolatedDeclarations requirements
  • Workspace dependency resolution
  • Coverage report generation

CI/CD

  • GitHub Actions workflows (test, lint, coverage, integration-test, publish)
  • Custom reusable actions in .github/actions/
  • Windows corepack workarounds

Quick Reference

  • Common commands (ibt, build:prod, snapshot updates)
  • pnpm filter patterns for targeted builds
  • Key files and directories
  • Integration test procedures

585 lines, 24 code examples, structured for quick scanning.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@Jason3S
Add comprehensive .github/copilot-instructions.md file
cfbb068 
- Document repository structure and monorepo setup
- Include development environment prerequisites
- Provide build, test, and lint commands
- Document common errors and workarounds
- Add CI/CD workflow information
- Include tips and best practices

Co-authored-by: Jason3S <3740137+Jason3S@users.noreply.github.com>
Copilot AI changed the title [WIP] Add onboarding instructions for Copilot coding agent Add Copilot coding agent onboarding documentation Feb 3, 2026
Copilot AI requested a review from Jason3S February 3, 2026 11:34
@Jason3S Jason3S marked this pull request as ready for review February 3, 2026 12:13
@Jason3S Jason3S merged commit 65d45ce into main Feb 3, 2026
14 checks passed
@Jason3S Jason3S deleted the copilot/add-copilot-instructions-file branch February 3, 2026 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@Jason3S Jason3S Jason3S approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@Jason3S Jason3S

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Jason3S