mirror of
https://github.com/scylladb/scylladb.git
synced 2026-05-22 07:42:16 +00:00
378bcd69e3
Add AGENTS.md as a minimal router that directs AI agents to the relevant instruction files based on what they are editing. Improve the instruction files: - cpp.instructions.md: clarify seastarx.hh scope (headers, not "many files"), explain std::atomic restriction (single-shard model, not "blocking"), scope macros prohibition to new ad-hoc only, add coroutine exception propagation pattern, add invariant checking section preferring throwing_assert() over SCYLLA_ASSERT (issue #7871) - python.instructions.md: demote PEP 8 to fallback after local style, clarify that only wildcard imports are prohibited - copilot-instructions.md: show configure.py defaults to dev mode, add frozen toolchain section, clarify --no-gather-metrics applies to test.py, fix Python test paths to use .py extension, add license header guidance for new files Closes scylladb/scylladb#29023
17 lines
831 B
Markdown
17 lines
831 B
Markdown
# ScyllaDB — AI Agent Instructions
|
|
|
|
This file routes you to the relevant instruction files.
|
|
Do NOT load all files at once — read only what applies to your current task.
|
|
|
|
## Instruction Files
|
|
|
|
- `.github/copilot-instructions.md` — build system, test runner, code philosophy, test philosophy
|
|
- `.github/instructions/cpp.instructions.md` — C++ style, Seastar patterns, memory, error handling (for `*.cc`, `*.hh`)
|
|
- `.github/instructions/python.instructions.md` — Python style, testing conventions (for `*.py`)
|
|
|
|
## Which files to read
|
|
|
|
- **Always read** `.github/copilot-instructions.md` for build/test commands and project values
|
|
- **If editing C++ files** (`*.cc`, `*.hh`): also read `.github/instructions/cpp.instructions.md`
|
|
- **If editing Python files** (`*.py`): also read `.github/instructions/python.instructions.md`
|