tidb-test-guidelines
Decide where to place TiDB tests and how to write them (basic structure, naming, testdata usage). Use when asked about test locations, writing conventions, shard_count limits, casetest categorization, or when reviewing test changes in code review.
64
75%
Does it follow best practices?
Impact
—
No eval scenarios have been run
Passed
No known issues
Optimize this skill with Tessl
npx tessl skill review --optimize ./.agents/skills/tidb-test-guidelines/SKILL.mdQuality
Discovery
100%Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.
This is a well-crafted skill description that clearly defines its scope around TiDB test placement and writing conventions. It provides both a clear 'what' and 'when' clause with domain-specific trigger terms that make it highly distinguishable. The description is concise yet comprehensive, covering the key scenarios where this skill should be activated.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | Lists multiple specific concrete actions: deciding test placement, writing tests with basic structure, naming conventions, testdata usage, shard_count limits, and casetest categorization. These are concrete, actionable capabilities. | 3 / 3 |
Completeness | Clearly answers both what ('Decide where to place TiDB tests and how to write them') and when ('Use when asked about test locations, writing conventions, shard_count limits, casetest categorization, or when reviewing test changes in code review'). | 3 / 3 |
Trigger Term Quality | Includes natural keywords users would say: 'test locations', 'writing conventions', 'shard_count', 'casetest', 'testdata', 'code review', 'test changes'. These are terms a TiDB developer would naturally use when asking about testing practices. | 3 / 3 |
Distinctiveness Conflict Risk | Highly specific to TiDB testing conventions with distinct triggers like 'shard_count limits', 'casetest categorization', and 'testdata usage' that are unlikely to conflict with other skills. | 3 / 3 |
Total | 12 / 12 Passed |
Implementation
50%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
The skill covers TiDB test placement and writing conventions comprehensively with a reasonable workflow and useful package-specific guidance. However, it lacks executable code examples (e.g., a sample test function skeleton), validation checkpoints in the workflow, and the package-specific notes section is dense enough that it would benefit from being extracted into a reference file. The content assumes Claude's competence appropriately but could be more actionable with concrete examples.
Suggestions
Add a concrete, executable example of a properly structured TiDB test function (with testkit, store setup, table-driven cases, and assertions) to improve actionability.
Add explicit validation steps to the workflow, such as 'Run `make bazel_test` to verify no regressions' after moving tests or updating BUILD.bazel.
Extract the lengthy 'Package-specific notes' section into a separate reference file (e.g., `references/package-test-notes.md`) and link to it from the SKILL.md to improve progressive disclosure and conciseness.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content is mostly efficient and avoids explaining basic concepts, but several bullet points in 'Package-specific notes' are quite dense and could be tightened. Some rules are overly specific (e.g., the explain-format paragraph) and border on verbose for a skill overview. | 2 / 3 |
Actionability | The skill provides concrete naming conventions, variable names, and specific commands (e.g., `rg --files -g '*_test.go'`, `-record -tags=intest,deadlock`), but lacks executable code examples showing a complete test structure. Many instructions are directive but not copy-paste ready—no example test function is provided. | 2 / 3 |
Workflow Clarity | The 'Quick workflow' section provides a clear 5-step sequence, but lacks explicit validation checkpoints or feedback loops. For operations like moving tests and updating BUILD.bazel (which can break builds), there's no 'verify build passes' or 'run affected tests' step before proceeding. | 2 / 3 |
Progressive Disclosure | References to external files like `references/planner-guide.md`, `references/<pkg>-case-map.md`, and `docs/agents/testing-flow.md` are present and clearly signaled. However, no bundle files were provided to verify these exist, and the package-specific notes section is quite long and could benefit from being split into a separate reference file rather than being inline. | 2 / 3 |
Total | 8 / 12 Passed |
Validation
100%Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.
Validation — 11 / 11 Passed
Validation for skill structure
No warnings or errors.
- Repository
- pingcap/tidb
- Commit
e70762e
- Reviewed
Table of Contents
Is this your skill?
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.