Code Conventions

OrganizationPopular

iflytek

code-conventions

Code style, logging, and testing conventions for SkillHub backend (Java) and frontend (TypeScript). Use when writing or reviewing code.

Overview

Publisher	iflytek
Repository	`skillhub`
Skill name	`code-conventions`
Stars	5.2K
Forks	841
Bundled files	Instructions only
License	Apache-2.0
Links	Skill source Repository Homepage

Markdown instructions
A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.
Works with any LLM
AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.
Self-contained
Everything the model needs lives in the instructions — no extra files to sync.
Open source
Published by iflytek on GitHub. Read the source before you install it.

Installation

Install the Code Conventions AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

Open the app and go to Plugins → Skills.
Choose "Install from GitHub".
Paste the skill folder URL below and confirm.
https://github.com/iflytek/skillhub/tree/main/.agents/skills/code-conventions
Enable the skill in any chat where you want it available.

Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills

git clone --depth 1 https://github.com/iflytek/skillhub.git /tmp/skillhub
mkdir -p .claude/skills
cp -r /tmp/skillhub/.agents/skills/code-conventions .claude/skills/code-conventions

Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Code Conventions in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Code Conventions on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Code Conventions is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

Loaded only when it is needed
The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.
Switch models mid-chat
Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Code Conventions Skill

Java / Backend Conventions

User Identity Type

User identity is always String throughout the codebase. This covers:

Authentication and authorization
API parameters and responses
Permission checks
Audit logs
Resource owner, creator, reviewer, actor, submittedBy fields

Never introduce int, long, or bigint as user identifiers. The platform needs to support external SSO/OIDC/SCIM identity sources whose UIDs are typically stable strings.

Exception Handling

Use LocalizedDomainException for user-facing error messages (supports i18n)
Use DomainBadRequestException for invalid client input
Use DomainNotFoundException for missing resources
Use DomainForbiddenException for authorization failures
Exception classes live in skillhub-domain/shared/exception/

Domain Services

Return domain objects, not DTOs
Contain business rules and state transitions
Use domain events for cross-cutting side effects (publishing, notifications)
Located in domain/{submodule}/service/

Controllers

Transport only: extract auth context, bind request params, wrap responses
No business logic in controllers
Located in com.iflytek.skillhub.controller/

Query Repositories

Handle read-model joins and presentation projection
Return DTOs or presentation models
Located in com.iflytek.skillhub.repository/
Named like *QueryRepository (e.g., GovernanceQueryRepository, MySkillQueryRepository)

App Services

Workflow orchestration: coordinate domain services and query repositories
Should express "what this endpoint does", not "how it assembles DTOs"
Located in com.iflytek.skillhub.service/

Logging

Use SLF4J with structured logging
Use MDC for request tracing
Log at appropriate levels: INFO for business events, DEBUG for troubleshooting, ERROR for failures

TypeScript / Frontend Conventions

Type Safety

Strict TypeScript mode. No any types.
Use generated OpenAPI types from web/src/api/generated/schema.d.ts for all API interactions.
Additional types in web/src/types/

Data Fetching

Always use TanStack Query (@tanstack/react-query) for server state
Never use useEffect for data fetching
Use openapi-fetch client for type-safe API calls

Component Composition

Radix UI primitives: @radix-ui/react-dropdown-menu, @radix-ui/react-select
class-variance-authority (cva) for component variants
clsx + tailwind-merge for class merging
cn() utility: web/src/shared/lib/utils.ts
shadcn/ui is NOT used as a library

State Management

TanStack Query for server state (API data, caching, invalidation)
Zustand for local/UI state (theme, sidebar, modals, form state)

Feature-Sliced Design

Layer	Path	Purpose
Pages	`web/src/pages/`	Route-level page components
Features	`web/src/features/`	Self-contained business features
Entities	`web/src/entities/`	Domain entity display logic
Shared	`web/src/shared/`	Reusable UI components, hooks, utilities

Place code at the lowest appropriate layer. Do not put page-level logic in shared.

Styling

Tailwind CSS for all styling
Follow existing component patterns
Use cn() for conditional class merging

Internationalization

Use i18next + react-i18next
All user-facing text must be translatable
Translation keys in web/src/i18n/

Testing Philosophy

Backend

JUnit 5 + Mockito + AssertJ
Use Spring Boot test slices where possible (@WebMvcTest, @DataJpaTest)
Test behaviors, not implementations
Use make test-backend-app (includes -am for dependent modules)
Never run ./mvnw -pl skillhub-app clean test directly — stale Maven cache causes misleading errors

Frontend

Vitest for unit tests
Playwright for E2E tests
Test component behavior and user interactions

Common Pitfalls

Maven multi-module: Always use -am flag or Makefile targets to include dependent modules
OpenAPI types: Must regenerate and commit after API contract changes
String identity: Never use numeric types for user identifiers
Controller business logic: Move to domain service or app service
Complex read-models in app service: Extract to query repository

Frequently asked questions

What does the Code Conventions AI skill do?

Code style, logging, and testing conventions for SkillHub backend (Java) and frontend (TypeScript). Use when writing or reviewing code.

Why use Code Conventions on TypingMind?

Because you install it once and use it with any model. Code Conventions is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Code Conventions in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/iflytek/skillhub/tree/main/.agents/skills/code-conventions. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Code Conventions?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Code Conventions?

As many as you like. As long as a model supports skills, you can use Code Conventions with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Code Conventions AI skill free?

Yes. It is published on GitHub by iflytek under the Apache-2.0 license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Openclaw Live Updater

openclaw

OrganizationPopular

Maintain the canonical live OpenClaw main checkout, macOS LaunchAgent-managed Gateway, local macOS app, exact-head main CI, and recurring full release validation. Use for fast-forward update…

Openclaw Pr Maintainer

openclaw

OrganizationPopular

Review, triage, repair, or land OpenClaw issues and pull requests with current-source evidence and the native maintainer workflow.

Openclaw Refactor Docs

openclaw

OrganizationPopular

Refactor an existing OpenClaw docs page with source-audited preservation, restructuring, and verification.

Openclaw Repair Sweep

openclaw

OrganizationPopular

Run scoped OpenClaw issue/PR repair campaigns: coordinate workers, prove root causes, and land or close verified work under the requested authority.

Overview

Installation

Install in TypingMind

Install in another agent

Use it in TypingMind

Works with any AI model

Skill instructions

Code Conventions Skill

Java / Backend Conventions

User Identity Type

Exception Handling

Domain Services

Controllers

Query Repositories

App Services

Logging

TypeScript / Frontend Conventions

Type Safety

Data Fetching

Component Composition

State Management

Feature-Sliced Design

Styling

Internationalization

Testing Philosophy

Backend

Frontend

Common Pitfalls

Frequently asked questions

Related AI Skills

Set up your own AI workspace now