Skip to content

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

Open
Copilot wants to merge 15 commits intoLTS-C++17from
copilot/add-copilot-instructions-file-another-one
Open

Add .github/copilot-instructions.md for agent onboarding#220
Copilot wants to merge 15 commits intoLTS-C++17from
copilot/add-copilot-instructions-file-another-one

Conversation

Copy link
Contributor

Copilot AI commented Mar 5, 2026

Adds a copilot-instructions.md to give a coding agent the context needed to work efficiently in this repo without exploratory overhead.

Contents

  • Project overview — what FKL is, main entry point (executeOperations), version, header-only nature
  • Repository structure — annotated directory tree covering include/, cmake/, tests/, utests/, benchmarks/
  • Build system — CMake 3.24+ requirements, all options (ENABLE_CUDA, CUDA_ARCH, BUILD_TEST, etc.), Linux/Windows build commands
  • CI matrix — self-hosted runner configurations, compiler combinations (g++-13, clang++-21, cl, clang-cl), CUDA 12.9/13.0, and the convention of setting CC/CXX/CUDACXX via env vars (not -D flags)
  • Test infrastructure — how .h files are auto-discovered, ONLY_CU/ONLY_CPU markers, launch() convention, how to add a test
  • Core concepts — operation type taxonomy (ReadType, WriteType, UnaryType, BinaryType, ReadBackType, etc.), InstantiableOperation wrappers and aliases (Read<>, Write<>, Unary<>, …), DPPs, key data types, fusion API (.then() / operator&), compiler macros, NVRTC support
  • Code style — LLVM clang-format, 4-space indent, 120-col limit, Apache 2.0 headers, namespace fk
  • CUDA notes — sm_70 minimum, DLL naming differences between CUDA 12 and 13, architecture detection
  • Known errors and workarounds — Windows/Ninja rules.ninja empty nvcc path, MSVC /bigobj + /Zc:preprocessor, template depth, CUDA all-arch filtering below sm_70
  • How to add a new operation — step-by-step guide for implementing and registering a new InstantiableOperation

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

Co-authored-by: albertandaluz <176801700+albertandaluz@users.noreply.github.com>
Copilot AI changed the title [WIP] Add Copilot instructions for onboarding Add .github/copilot-instructions.md for agent onboarding Mar 5, 2026
@albertandaluz albertandaluz requested a review from Copilot March 12, 2026 09:30
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a .github/copilot-instructions.md file to onboard AI coding agents with comprehensive context about the FusedKernelLibrary repository, covering build system, CI, testing, core concepts, code style, and common workarounds.

Changes:

  • New copilot-instructions.md documenting project overview, repo structure, build/CI setup, test infrastructure, core API concepts, code style, and how to add new operations.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@albertandaluz albertandaluz marked this pull request as ready for review March 12, 2026 10:05
@albertandaluz albertandaluz requested a review from Copilot March 12, 2026 10:05
@albertandaluz albertandaluz added the enhancement New feature or request label Mar 12, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

clarifty that the macros exists, but we don't build and test with them and will soon be removed
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

morousg
morousg previously approved these changes Mar 12, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
morousg and others added 3 commits March 12, 2026 17:17
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…-file-another-one' into copilot/add-copilot-instructions-file-another-one

* origin/copilot/add-copilot-instructions-file-another-one:
  Update .github/copilot-instructions.md
  Update .github/copilot-instructions.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants