Skip to content

Add .github/copilot-instructions.md for agent onboarding#2015

Merged
Jym77 merged 8 commits intomainfrom
copilot/add-copilot-instructions-file
Mar 11, 2026
Merged

Add .github/copilot-instructions.md for agent onboarding#2015
Jym77 merged 8 commits intomainfrom
copilot/add-copilot-instructions-file

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 27, 2026

Adds onboarding documentation for GitHub Copilot coding agents working on Alfa for the first time.

Contents

Technical Environment

  • TypeScript 5.9.3 strict mode, ES2022 target, ESM with .js import extensions required
  • Node.js ≥20, Yarn 4.12.0 Berry, 80+ workspace packages in monorepo
  • Vitest with coverage thresholds (75% lines, 80% branches)
  • Custom TypeScript solution builder, 3-4 min build time, 8GB memory requirement

Critical Conventions

  • Tests import from dist/ not src/ - must build before testing
  • All packages share synchronized version number
  • Changesets required for API/behavior changes: **[kind]:** [title] format
  • Functional programming patterns: Option, Result, Either types throughout

Workflows Documented

  • Build/test/watch commands with package-specific variants
  • Changeset creation and release process
  • API extraction and dependency analysis with knip
  • Scratch file experimentation setup
  • CI/CD integration workflow details

Troubleshooting

  • Common build, test, and dependency issues
  • TypeScript ESM gotchas
  • Memory and performance considerations
  • Package reference synchronization

Quick command reference and best practices included for efficient agent operation.


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Feb 27, 2026

⚠️ No Changeset found

Latest commit: 337ab8a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copilot AI and others added 2 commits February 27, 2026 14:54
Co-authored-by: Jym77 <19969498+Jym77@users.noreply.github.com>
Co-authored-by: Jym77 <19969498+Jym77@users.noreply.github.com>
Copilot AI changed the title [WIP] Add Copilot instructions for onboarding Add .github/copilot-instructions.md for agent onboarding Feb 27, 2026
@Jym77 Jym77 added the documentation Update to documentation only label Feb 27, 2026
@github-project-automation github-project-automation bot moved this to 🧑‍💻 Doing in ⚙️ Alfa Development Feb 27, 2026
@Jym77 Jym77 marked this pull request as ready for review February 27, 2026 15:39
@Jym77 Jym77 requested a review from a team as a code owner February 27, 2026 15:39
@Jym77 Jym77 added this pull request to the merge queue Mar 11, 2026
Merged via the queue into main with commit 78db669 Mar 11, 2026
9 checks passed
@Jym77 Jym77 deleted the copilot/add-copilot-instructions-file branch March 11, 2026 09:50
@github-project-automation github-project-automation bot moved this from 🧑‍💻 Doing to 🏁 Done in ⚙️ Alfa Development Mar 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Update to documentation only

Projects

Status: 🏁 Done

Development

Successfully merging this pull request may close these issues.

3 participants