Add comprehensive onboarding guide for AI coding agents#7677
Add comprehensive onboarding guide for AI coding agents#7677
Conversation
Co-authored-by: eddyashton <6000239+eddyashton@users.noreply.github.com>
|
|
||
| **CCF** is an open-source framework for building secure, highly available, and performant applications focused on multi-party compute and data. It's designed for confidential, distributed systems running on secure hardware. | ||
|
|
||
| **Primary languages**: C++ (core framework), TypeScript/JavaScript (application development), Python (testing and tooling) |
There was a problem hiding this comment.
How is this of any use for a robot actually? Can we have a short human-readable bullet points file, which can be easily review and extended instead?
|
@maxtropets I suggest skimming https://arxiv.org/abs/2602.11988 |
Well, the abstract says the same?.. |
Interesting source. I think the mention of increased project-specific tool use and testing is interesting, and something we'd really benefit from. A drop in success rate is annoying, but hard to measure. The citation on the benefits of a security prompt looks valuable too. On balance, I think these auto-generated instructions are too long (bloating the context window), unfocussed, and occasionally outright misleading (ie - mention |
Expanded
.github/copilot-instructions.mdfrom minimal placeholder to comprehensive 408-line onboarding guide for AI coding agents working in the CCF repository.Sections Added
BUILD_TESTS,SAN,CLANG_TIDY), 32GB RAM requirement./tests.shwrapper for venv setupscripts/ci-checks.sh -fenforcement for clang-format, ruff, prettierLOG_*_FMT), error handling patternsrun-long-test,bench-ab)Key Requirements Documented
Shell Script Requirement
Codified existing rule: scripts using pipes must set
set -o pipefailto catch mid-pipeline failures.Note: Commit includes minor C++ formatting fixes (whitespace before
{};) auto-applied by ci-checks.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.