Skip to content

Conversation

@ArshdeepSingh728281
Copy link
Contributor

Summary

This PR adds configuration and documentation files to improve GitHub Copilot and Copilot Chat integration with the cdxgen project.
These files help AI coding agents and new contributors better understand the project’s structure, technologies, and workflows.


Changes Introduced

  • Added copilot-instructions.md

    • Includes project overview, folder structure, and core technologies
    • Documents build and test workflow for contributors
    • Provides clear guidance for Copilot and similar tools
  • Added copilot-setup.yml

    • Defines Copilot environment configuration (Node.js, TypeScript, pnpm)
    • Lists key configuration files and build/test commands
    • Excludes unnecessary directories for cleaner context
  • (Optional) Updated README.md to reference Copilot setup for contributors


Motivation

Implements and fixes #2172

“Make it easy for Copilot, Claude, etc., to understand our codebase and make it easy for contributors to send PRs using these tools.”

These additions ensure that Copilot and similar coding agents can:

  • Interpret the repo’s structure and dependencies
  • Suggest context-aware completions for contributors
  • Simplify the onboarding and PR contribution flow

Verification

  • ✅ Ran pnpm run lint — no issues found
  • ✅ Ran pnpm test — all tests passed
  • ✅ Verified consistency with existing documentation and repo style

Checklist


Note for Maintainers:
This PR introduces no runtime or functional code changes — only documentation and configuration enhancements.

@ArshdeepSingh728281 ArshdeepSingh728281 force-pushed the feature/copilot-agent-support branch from 244dd3b to 3140c42 Compare November 4, 2025 12:48
@malice00
Copy link
Collaborator

Thanks for the PR! I asked @prabhu to take a look at this, as this is more in his wheelhouse.

! thing though: did you actually remove both README.MD files in this branch? Maybe you can look into that and fix that? Might be a good idea to start a new branch and just cherry-pick the commit(s) you actually need for this PR...

@ArshdeepSingh728281
Copy link
Contributor Author

Closing this in favor of #2764 — a clean, conflict-free version.
It only adds the Copilot support files under .github/ and doesn’t touch README or workflow files.
Thanks @malice00 and @prabhu for reviewing and guiding me through the cleanup!

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.

Support for GitHub Copilot coding agent

2 participants