Skip to content

docs(skill): split testcase-authoring into SKILL and REFERENCE - #34791

Closed
tomchon wants to merge 4 commits into
mainfrom
docs/test-skills-fastpush
Closed

tomchon wants to merge 4 commits into
mainfrom
docs/test-skills-fastpush

Conversation

@tomchon

@tomchon tomchon commented Mar 15, 2026

Copy link
Copy Markdown
Contributor

split testcase authoring skill into a lightweight entry file and a detailed reference file

@tomchon
tomchon requested a review from a team as a code owner March 15, 2026 07:27
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the documentation for the testcase-authoring skill by separating its core definition from its detailed reference content. This restructuring aims to improve the organization and accessibility of the skill's guidelines, making it easier for users to quickly grasp its purpose while providing a dedicated resource for in-depth information. The change aligns the skill's format with recommended practices for Claude Agent Skills, enhancing user experience without altering the skill's underlying functionality.

Highlights

  • Documentation Split: The testcase-authoring skill documentation has been split into two distinct files: a lightweight SKILL.md for quick discovery and a comprehensive REFERENCE.md for detailed guidance.
  • Progressive Loading: Extensive guidance and examples related to TDengine test case authoring have been moved from SKILL.md to the new REFERENCE.md to support progressive loading best practices.
  • Skill Discovery: The essential YAML frontmatter required for Claude skill discovery has been retained in the SKILL.md file, ensuring the skill remains discoverable.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • .claude/skills/testcase-authoring/REFERENCE.md
    • Added a new file containing comprehensive guidelines for TDengine test case authoring, including sections on optimization principles, timeout handling, batch inserts, code quality, and data volume control.
  • .claude/skills/testcase-authoring/SKILL.md
    • Modified to serve as a lightweight entry point, retaining essential metadata and providing a high-level overview, workflow, quick checklist, and examples.
    • Removed detailed content, which was moved to the newly created REFERENCE.md file.
Activity
  • The pull request was created by tomchon.
  • The pull request description clearly outlines the summary of changes, the files involved, and the rationale for the update, emphasizing alignment with Claude Agent Skills recommendations.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@tomchon
tomchon changed the base branch from docs/test-skills to main March 15, 2026 07:30
@tomchon
tomchon requested a review from feici02 as a code owner March 15, 2026 07:30

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request effectively refactors the testcase-authoring skill documentation by splitting it into a concise SKILL.md entry file and a detailed REFERENCE.md. This change aligns with best practices for progressive disclosure and makes the skill easier to consume for the AI agent. The new REFERENCE.md provides comprehensive and clear guidelines for writing test cases. I have one minor suggestion to improve the consistency of a code example within the reference document.

Comment thread .claude/skills/testcase-authoring/REFERENCE.md
Copilot AI review requested due to automatic review settings April 29, 2026 11:24

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR restructures the “testcase-authoring” documentation skill by splitting it into a short entry-point “SKILL” file and a more detailed “REFERENCE” file, while also updating docs CI filtering to avoid running on .claude/** Markdown changes.

Changes:

  • Add .claude/skills/testcase-authoring/SKILL.md as a lightweight entry file pointing to the reference.
  • Add .claude/skills/testcase-authoring/REFERENCE.md with detailed, actionable testcase authoring guidance.
  • Update docs CI workflow to exclude .claude/** from trigger paths and Markdown changed-file detection; add .autocorrectrc for AutoCorrect configuration.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
.github/workflows/tdengine-docs-ci.yml Excludes .claude/** from docs CI trigger paths and from Markdown changed-file detection.
.claude/skills/testcase-authoring/SKILL.md New lightweight skill entry file referencing the detailed guide.
.claude/skills/testcase-authoring/REFERENCE.md New detailed reference guide for testcase authoring patterns and pitfalls.
.autocorrectrc New AutoCorrect configuration (includes/excludes and rule toggles).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@@ -11,6 +11,7 @@ on:
- 'docs/**'
- '.github/workflows/tdengine-docs-ci.yml'

Copilot AI Apr 29, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The workflow is now skipping .claude/** Markdown changes (good), but changes to the new .autocorrectrc file itself won’t trigger this docs CI because it’s neither under docs/** nor **/*.md. If .autocorrectrc controls AutoCorrect behavior for docs, consider adding .autocorrectrc to the on.pull_request.paths list so config changes get validated by CI.

Suggested change
- '.github/workflows/tdengine-docs-ci.yml'
- '.github/workflows/tdengine-docs-ci.yml'
- '.autocorrectrc'

Copilot uses AI. Check for mistakes.
@tomchon tomchon closed this May 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants