跳到正文
cccskills
免费在 GitHub 公开

coding-standards

Apply Apache ShardingSphere’s written coding standards during implementation or review, covering naming, Java constructs, tests, and Maven dependencies. Also audit a specified scope without editing files, combining automated checks with manual inspection of applicable rules.

中文简介正在准备中。当前显示英语简介。

原文查看原文说明

Apply Apache ShardingSphere's written coding standards when explicitly requested, or when code-implementation routes task-changed production, test, script, build, generated, or Maven POM artifacts through repository standards. Also perform a standalone read-only compliance audit of a user-specified scope. Use CODE_OF_CONDUCT.md, applicable AGENTS.md rules, Checkstyle, Spotless, and other repository-defined standards, including naming and evidence-based defensive-code rules. Do not invoke independently for an ordinary implementation already governed by code-implementation, and do not independently audit architecture, runtime ownership, caches, or lifecycle.

查看安装方法

适用场景

  • Check changed code against written repository standards
  • Review Java naming and declaration conventions
  • Verify changed Maven dependency declarations
  • Audit a specified package or module without editing files

包含的文件(17)

  • SKILL.md9.3 KB
  • agents/openai.yaml1.0 KB
  • references/rules/defensive-code.md9.0 KB
  • references/rules/java-annotation-order.md3.7 KB
  • references/rules/java-collections.md4.9 KB
  • references/rules/java-constructors.md2.3 KB
  • references/rules/java-exceptions.md2.5 KB
  • references/rules/java-expressions.md1.9 KB
  • references/rules/java-line-wrapping.md5.9 KB
  • references/rules/java-naming.md5.7 KB
  • references/rules/java-preconditions.md4.2 KB
  • references/rules/java-testing.md4.2 KB
  • references/rules/java-types.md1.5 KB
  • references/rules/maven-dependencies.md6.8 KB
  • references/standalone-audit.md10.7 KB
  • scripts/build_audit_inventory.py14.9 KB
  • scripts/tests/test_build_audit_inventory.py17.2 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->

Coding Standards

Use this Skill in exactly one of the following modes. Both modes derive compliance only from written standards that actually apply to the target files. For routing purposes, covered declaration annotations are HighFrequencyInvocation, AllArgsConstructor, RequiredArgsConstructor, NoArgsConstructor, Builder, Getter, Setter, EqualsAndHashCode, ToString, and Slf4j.

Implementation Guidance Mode

Use this mode when implementing, fixing, refactoring, or reviewing code, or when modifying or reviewing a Maven POM, unless the user explicitly requests a standalone coding-standards compliance audit. Read only the references whose conditions below match the affected files and task delta, and add each selected reference's applicable rules to one checklist grouped by governing file set.

  • Before starting a read-only code review or making the first write in an implementation task, read the portions of CODE_OF_CONDUCT.md, repository-level and path-level AGENTS.md, Checkstyle, Spotless, and other written repository standards that actually apply to every affected file.
  • For a changed or reviewed pom.xml, read Maven dependency version rules and apply them only to dependency declarations changed by the task.
  • Read Java naming rules when the task adds or changes a field, local variable, parameter, lambda, returned-value temporary or direct return, or enhanced loop. When a type declaration or its type annotations change, read Java type rules.
  • Before adding or validating HighFrequencyInvocation, apply the CODE_OF_CONDUCT.md definition by identifying the supported normal workload and verifying that the target's work repeats as that workload's throughput grows. Invocation after each DDL or explicit metadata refresh request proves reachability, not high frequency by itself. Leave applicability uncertain when normal-workload evidence is insufficient; do not add the annotation or rewrite Streams solely from reachability or theoretical repeatability. Do not require a TPS benchmark solely to classify these paths.
  • Before adding, changing, or reordering a covered declaration annotation, or when a Java declaration added or modified by the task contains at least two covered annotations, read the Java declaration annotation order rules through EOF and add each applicable rule to the checklist.
  • Read Java constructor rules before changing an explicit or generated constructor or a field that may alter its signature or behavior.
  • Before adding or changing a Java throw statement, a conditional branch that throws, a validation or precondition call, or a call to ShardingSpherePreconditions, read the Java precondition rules through EOF and add each applicable rule to the checklist.
  • Before adding or changing a Java method annotated with lombok.SneakyThrows or changing the checked-exception behavior of such a method, read the Java exception handling rules through EOF and add each applicable rule to the checklist.
  • Before adding or changing a Java declaration whose type is a java.util.Collection interface or implementation, read the Java collection declaration rules through EOF and add each applicable rule to the checklist.
  • Before adding or changing a Java expression that copies Collections.singleton, Collections.singletonMap, or Arrays.asList into ArrayList, LinkedList, HashMap, or LinkedHashMap, read the Java collection rules through EOF and add each applicable rule to the checklist.
  • Read Java expression rules before changing == or != when an operand may resolve to a named constant.
  • Before adding or changing a multi-line Java declaration header, statement, or expression, or a Java physical line that may exceed 200 characters, read the Java line-wrapping rules through EOF and add each applicable rule to the checklist.
  • For every affected Java test file, read the Java test code rules through EOF and add each applicable rule to the checklist.
  • Read defensive-code rules before adding, changing, removing, or reviewing a defensive construct.
  • Apply each rule according to whether its text governs existing code or only the current task delta, and never beyond authorized scope.
  • After the last write, manually recheck the effective task delta and only the surrounding declarations needed to evaluate every applicable checklist rule.
  • For Java, explicitly verify every applicable CODE_OF_CONDUCT.md coding rule, including declaration order; when a method uses private helpers, verify that those helpers immediately follow the caller and appear in the caller's call order, regardless of the caller's visibility.
  • For Java, explicitly verify every applicable Java declaration annotation order rule against each declaration added or modified by the task.
  • For Java, explicitly verify every applicable Java exception handling rule against each added or modified lombok.SneakyThrows annotation and the method bodies, invoked signatures, rethrown values, and contracts needed to resolve its exception types.
  • For Java, explicitly verify every applicable Java collection declaration rule against the effective task delta and the operations, callers, callees, overrides, and contracts needed to determine the least-specific required declaration type.
  • For Java, explicitly verify every applicable mutable-collection construction rule against the effective task delta and the operations, aliases, callers, callees, and contracts needed to determine whether mutability is required.
  • For Java, when line-wrapping rules were selected, explicitly verify them against each applicable declaration header, statement, and expression added or modified by the task.
  • For Java tests, explicitly verify every applicable Java test code rule against the effective task delta and the declarations and member types needed to resolve semantic applicability.
  • Recheck every other selected rule only against the task delta and the context needed to decide applicability.
  • Treat passing Checkstyle and Spotless as evidence only for the rules those tools enforce; neither result replaces the manual recheck.
  • A later write invalidates final-check evidence only for affected files and rules; recheck those portions before verification or handoff.
  • Do not invent rules from preference or nearby code, and do not report pre-existing violations outside task scope.
  • Run the applicable formatting and standards checks required by the repository workflow.
  • Do not run apply, format, or another file-modifying command unless the current task authority and repository rules authorize every possible write.
  • Do not build a complete file inventory or count physical lines to report audit coverage in this mode. Measure the length of applicable Java constructs as required by the line-wrapping rules.

This mode constrains the current task; it is not a repository-wide audit.

Standalone Compliance Audit Mode

Use this mode only when the user explicitly asks for a coding-standards compliance audit of an exact file, package, Maven module, directory, or the whole repository. Keep the audit read-only and read the standalone compliance audit workflow through EOF; it defines reference selection, complete inventory, inspection, and reporting.

This Skill may inspect architecture, ownership, lifecycle, concurrency, and runtime paths only when those facts determine whether an applicable written coding standard is satisfied.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Investigate Apache ShardingSphere issues using official documentation, code, tests, and issue discussions. Distinguish bugs, unsupported usage, duplicates, and enhancement requests, then draft a concise maintainer-style reply explaining the evidence and next action.

中文简介正在准备中。当前显示英语简介。

  • Distinguish bugs from unsupported configurations
  • Check whether an issue duplicates an earlier report or fix
  • Draft a GitHub issue reply with clear next steps
apache/shardingsphere2.1万2026年10月19日 更新

Implement, fix, refactor, or remove repository code through a defined workflow. It connects each change to an acceptance criterion, checks effects on existing behavior, and guides focused testing, change review, and verification.

中文简介正在准备中。当前显示英语简介。

  • Implementing a feature within an agreed scope
  • Fixing bugs while preserving existing behavior
  • Checking impacts before removing code
apache/shardingsphere2.1万2026年10月19日 更新

gen-ut

免费

Create or improve unit tests for Apache ShardingSphere classes. Cover the target class’s behavior and affected branches, verify explicitly requested coverage goals, and consolidate suitable scenarios into parameterized tests, which run the same checks with different inputs.

中文简介正在准备中。当前显示英语简介。

  • Add missing unit tests for a target class
  • Verify an explicitly requested coverage target
  • Consolidate suitable tests with different input data
apache/shardingsphere2.1万2026年10月19日 更新

review-pr

免费

Review Apache ShardingSphere pull requests or authorized downstream changes using repository evidence. Assess code correctness, merge readiness, or CI failures, then produce consolidated findings or a ready-to-copy reply to a review discussion.

中文简介正在准备中。当前显示英语简介。

  • Review code changes for correctness and regression risks
  • Assess whether a pull request is ready to merge
  • Investigate CI failures
apache/shardingsphere2.1万2026年10月19日 更新

查看 apache 的全部技能

报告此技能的问题