Skip to content

Add Copilot onboarding instructions for ACK monorepo#92

Merged
leoafarias merged 2 commits intomainfrom
copilot/add-copilot-instructions-file
Mar 6, 2026
Merged

Add Copilot onboarding instructions for ACK monorepo#92
leoafarias merged 2 commits intomainfrom
copilot/add-copilot-instructions-file

Conversation

Copy link
Contributor

Copilot AI commented Mar 6, 2026

This PR onboards btwld/ack for first-time Copilot coding agents by adding repository-specific working guidance in .github/copilot-instructions.md. It captures the project’s execution model and explicitly documents onboarding/CI friction points with practical workarounds.

  • What was added

    • New file: .github/copilot-instructions.md
    • Agent-focused guidance for:
      • monorepo/package layout (ack, ack_annotations, ack_generator, adapters, example)
      • setup prerequisites and bootstrap flow (Dart/Flutter, Melos, optional setup.sh)
      • canonical commands for analysis/tests/build/golden/json-schema validation
      • change-scope expectations (minimal, package-scoped, avoid manual edits to generated files)
  • CI and release context captured

    • References the delegated CI workflow model (.github/workflows/ci.yml → shared dart-actions workflow with DCM)
    • Notes Conventional Commit expectation and publishing/versioning entrypoints from PUBLISHING.md
  • Documented errors + workarounds (per issue requirement)

    • melos: command not found → install/activate Melos or use dart run melos ...
    • dart: command not found → install Dart SDK (or run ./setup.sh) before bootstrap
    • CI run in action_required with no jobs → maintainer approval/permissions required before rerun
## Commands you should run
- Full CI-equivalent local check: `melos run test --no-select`
  - Runs strict analyze (`dart analyze . --fatal-infos`) and package tests.

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@docs-page
Copy link

docs-page bot commented Mar 6, 2026

To view this pull requests documentation preview, visit the following URL:

docs.page/btwld/ack~92

Documentation is deployed and generated using docs.page.

Co-authored-by: leoafarias <435833+leoafarias@users.noreply.github.com>
Copilot AI changed the title [WIP] Add Copilot instructions for efficient onboarding Add Copilot onboarding instructions for ACK monorepo Mar 6, 2026
@leoafarias leoafarias marked this pull request as ready for review March 6, 2026 15:12
@leoafarias leoafarias merged commit 9333dc5 into main Mar 6, 2026
@leoafarias leoafarias deleted the copilot/add-copilot-instructions-file branch March 6, 2026 15:12
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