Skip to content

Add .github/copilot-instructions.md#1697

Merged
gaius-qi merged 2 commits intomainfrom
copilot/create-copilot-instructions
Mar 9, 2026
Merged

Add .github/copilot-instructions.md#1697
gaius-qi merged 2 commits intomainfrom
copilot/create-copilot-instructions

Conversation

Copy link
Contributor

Copilot AI commented Mar 9, 2026

Documents codebase conventions and architecture for GitHub Copilot (and human contributors) in the canonical .github/copilot-instructions.md location.

What's covered

  • Workspace layout — table of all 9 crates and their roles
  • Rust conventions — toolchain (1.85.0), edition (2021), cargo fmt / cargo clippy -D warnings, mandatory Apache 2.0 file header
  • Error handlingDFError enum, Result<T> alias, OrErr trait; no unwrap() in production paths
  • Logging & tracingtracing crate usage, log-level guide, #[instrument(skip_all)], span propagation into spawned tasks
  • Async conventions — Tokio patterns, Arc<T> sharing, RwLock preference, spawn_blocking for CPU work
  • Testing#[cfg(test)] placement, #[tokio::test], test dependencies (mocktail, wiremock, criterion), test commands
  • Key dependencies — reference table (tonic, hyper, reqwest, rocksdb, opendal, quinn, etc.)
  • Storage layer — three-layer design (RocksDB metadata → content files → LRU cache), DatabaseObject trait contract
  • Build & CI — canonical cargo check / fmt / clippy / llvm-cov commands and workflow descriptions
  • Platform targets — four supported triples, Linux-only feature gating pattern
  • Performance notes — JeMalloc, release profile flags, pprof integration

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…hitecture docs

Co-authored-by: gaius-qi <15955374+gaius-qi@users.noreply.github.com>
Copilot AI changed the title [WIP] Add copilot instructions for project setup Add .github/copilot-instructions.md Mar 9, 2026
Copy link
Member

@gaius-qi gaius-qi left a comment

Choose a reason for hiding this comment

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

LGTM

@gaius-qi gaius-qi marked this pull request as ready for review March 9, 2026 07:42
@gaius-qi gaius-qi enabled auto-merge (squash) March 9, 2026 07:42
@gaius-qi gaius-qi added the enhancement New feature or request label Mar 9, 2026
@gaius-qi gaius-qi added this to the v2.5.0 milestone Mar 9, 2026
Copy link
Member

@chlins chlins left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Member

@gaius-qi gaius-qi left a comment

Choose a reason for hiding this comment

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

LGTM

@gaius-qi gaius-qi disabled auto-merge March 9, 2026 07:45
@gaius-qi gaius-qi merged commit ac05c16 into main Mar 9, 2026
5 of 7 checks passed
@gaius-qi gaius-qi deleted the copilot/create-copilot-instructions branch March 9, 2026 07:45
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.

3 participants