tidb-coding-reference

Standardize TiDB coding contributions with implementation rules and quality guardrails.

Updated Mar 3, 2026
One-click install
npx skills add https://github.com/D3Hunter/ai-engineer --skill tidb-coding-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tidb-coding-reference
Source: https://github.com/D3Hunter/ai-engineer/tree/main/skills/tidb-coding-reference
Command: npx skills add https://github.com/D3Hunter/ai-engineer --skill tidb-coding-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the risk of inconsistent, non-compliant code contributions to the pingcap/tidb project by providing a standardized, experience-backed coding playbook, removing the need to reinvent implementation patterns or debug avoidable pitfalls from scratch.

Core Features & Use Cases

  • Standardized Implementation Heuristics: Clear rules for storage SQL, service/handler logic, runtime visibility guards, and data semantics to align with TiDB project conventions.
  • Built-in Quality Guardrails: Test design patterns, completion checklists, and common pitfall warnings to ensure cross-layer consistency and pass code reviews faster.
  • Use Case: When contributing new features or bug fixes to pingcap/tidb, use this Skill to validate your implementation against proven patterns, avoid common errors like incorrect visibility guards or flawed duration aggregation, and meet project quality standards.

Quick Start

Use the tidb-coding-reference skill to guide your implementation of a new TiDB storage method and associated HTTP handler, ensuring it follows project conventions for SQL semantics, error handling, and test coverage.

Frequently Asked Questions about tidb-coding-reference

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are the TiDB coding standards for storage SQL implementation and error propagation?

TiDB coding standards enforce strict package boundaries, correct literal data semantics, and proper error propagation to ensure production-ready storage SQL and service logic.

How do I implement runtime visibility guards and duration aggregation in pingcap/tidb?

Implement runtime visibility guards by applying standardized heuristics to prevent incorrect visibility configurations and flawed duration aggregation in TiDB service handlers.

Does this coding reference cover cross-layer test design patterns for TiDB development?

Yes, this coding reference provides built-in quality guardrails, test design patterns, and completion checklists to ensure comprehensive cross-layer test coverage for TiDB changes.

How do I validate my TiDB code contributions to pass project code reviews faster?

Validate TiDB code contributions against standardized implementation heuristics and common pitfall warnings to align with project conventions and pass code reviews faster.

Can I use this reference for both new feature development and bug fixes in TiDB?

Yes, apply this reference to both new feature development and bug fixes in pingcap/tidb to validate implementations against proven patterns and eliminate non-compliant code.

What are common pitfalls when contributing to TiDB storage methods and HTTP handlers?

Common pitfalls include incorrect visibility guards, flawed duration aggregation, and improper error propagation when implementing TiDB storage methods and associated HTTP handlers.