OpenParable
Skip to content
← Back to skills

Cpp Coding

Development
cpp-coding

Cpp Coding is an Agent Skill for development published in the timeplus-io/proton repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Write or review Timeplus/Proton C++20 code covering naming conventions, Proton fences, clang-format, IProcessor patterns, and checkpointing. Make sure to use this skill for any C++ code changes, additions, or reviews in this codebase, including small fixes, new functions, refactoring, or style questions, even if the user doesn't explicitly mention coding conventions.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/timeplus-io/proton/blob/HEAD/.claude/skills/cpp-coding/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/cpp-coding, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

C++ Coding

Language

C++20. Prefer standard library over custom implementations when appropriate.

Naming conventions

ElementStyleExample
FunctionslowerCamelCaseprocessStreamData(), handleWindowClose()
Variableslowercase_with_underscoresevent_count, window_start
ClassesPascalCaseStorageStream, AggregatedDataVariants
ConstantsPascalCase or UPPER_CASEPer existing codebase convention
NamespacesPascalCaseDB::Streaming

Proton fences

/// proton: starts
if (isStreamingQuery()) { handleStreamingPath(); }
/// proton: ends
  • Use ONLY in ClickHouse-inherited code (upstream-synced files)
  • NEVER fence in src/Storages/Stream/ or namespace DB::Streaming
  • NEVER nest fences

IProcessor pattern (streaming transforms)

All streaming transforms in src/Processors/Transforms/Streaming/ follow:

class MyTransform : public IProcessor {
    Status prepare() override;  // O(1), non-blocking, check readiness
    void work() override;       // Do actual processing
};

Stateful processors MUST also implement:

  • hasState() → return true
  • checkpoint(CheckpointContextPtr) → serialize state
  • recover(CheckpointContextPtr) → restore from checkpoint

Formatting

Only formats changed code blocks (not entire files). Uses .clang-format config at repo root. The configured brace style is Allman-like: opening braces normally go on a new line.

git clang-format              # format unstaged changes in-place
git clang-format --staged     # format staged changes in-place
git clang-format --diff       # dry-run: show what would change
git clang-format <commit>     # format changes since <commit>

Comments

Use ///. Explain why, not what:

/// Use 10 seconds to allow late events
watermark_delay = 10;