clickhouse-sink-connector
Copilot instructions345 starsChanged 35 days agoApache-2.0View on GitHub
Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.
Of the Copilot instructions files we read, the 2,343 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository17 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- clickhouse-sink-reviewSkill
- code-quality-architectureSkill
- code-quality-bashSkill
- code-quality-goSkill
- code-quality-jvmSkill
- code-quality-pythonSkill
- code-quality-sqlSkill
- code-reuse-firstSkill
- code-reuse-reviewSkill
- design-note-debtSkill
- destructive-operation-safetySkill
- mandatory-code-change-validationSkill
- pr-self-reviewSkill
- repro-harness-negative-proofSkill
- sink-connector-mysql-source-of-truthSkill
The file
We split this copilot-instructions.md into the rules it gives an agent
6 rules. About 0 are common, 3 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 10
Every change must begin with a specification declaration in specs/.
- Distinctive: line 11
Never generate code changes that diverge from or expand beyond declared specifications.
- Distinctive: line 16
Every divergence is resolved by making ClickHouse match MySQL.
- Distinctive: line 18
If MySQL defines a column that ClickHouse marks as MATERIALIZED, the MySQL value wins.
- Very specific: line 21
Every modification must preserve the 13 System Invariants (I1–I13) defined in specs/CONSTITUTION.md.
- Very specific: line 23
Always validate with python3 scripts/validate_specs.py.
≈ “Common” is an estimate: at least 1 in 5 of the 3,779 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
GitHub Copilot Instructions: ClickHouse Sink Connector
Architectural Philosophy & Core Contract
The ClickHouse Sink Connector is strictly defined as an exact, zero-loss replication tool from MySQL to ClickHouse using the MySQL binary log (binlog).
Non-Negotiable Operational Rules
- Spec-Driven Development (Mandatory):
- This repository follows the Smart Ralph spec-driven development protocol (
specs/SMART_RALPH_PROTOCOL.md). - Every change must begin with a specification declaration in
specs/. - Never generate code changes that diverge from or expand beyond declared specifications.
- This repository follows the Smart Ralph spec-driven development protocol (
- The Prime Directive: MySQL Is the Source of Truth:
- The source MySQL database is always correct.
- ClickHouse is the replica and must conform to MySQL.
- Every divergence is resolved by making ClickHouse match MySQL.
- ALIAS columns are ignored (query-time only).
- If MySQL defines a column that ClickHouse marks as MATERIALIZED, the MySQL value wins; the connector converts the ClickHouse column to DEFAULT to permit writing.
- Invariants & Formal Verification:
- Every modification must preserve the 13 System Invariants (I1–I13) defined in
specs/CONSTITUTION.md. - The system state machine is formally modeled in Lean 4 (
formal_specs/lean/). Do not introduce non-monotonic versioning or un-tombstoned sorting key mutations. - Always validate with
python3 scripts/validate_specs.py.
- Every modification must preserve the 13 System Invariants (I1–I13) defined in
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.