Agent skill

Coding Conventions

by shopsys in shopsys/shopsys

Coding principles and conventions for the Shopsys monorepo — DRY/KISS/reuse, comment and docblock quality, test-code rules, the per-folder visibility/typing rules (packages vs project-base vs…

Custom licenceAuto-check passedDevelopment

Install Coding Conventions

skills CLI
$ npx skills add shopsys/shopsys --skill coding-conventions -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install shopsys/shopsys coding-conventions --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/shopsys/shopsys.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/coding-conventions .claude/skills/coding-conventions && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
coding-conventions
GitHub stars
350
Token cost
~1.1k tokens
SKILL.md length
526 words
Files
1
Skills in repo
46
Repo updated
First seen
Licence
Custom licence

At a glance

Coding principles and conventions for the Shopsys monorepo — DRY/KISS/reuse, comment and docblock quality, test-code rules, the per-folder visibility/typing rules (packages vs project-base vs…

  • Works in 4 steps: Remove it — truly dead code is deleted,… → Whole-class entry (identifier + path, no… → Member entry (identifier + exact-message… → …
  • Tasks that involve Monorepo tooling
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Coding Conventions is an agent skill from shopsys/shopsys. Coding principles and conventions for the Shopsys monorepo — DRY/KISS/reuse, comment and docblock quality, test-code rules, the per-folder visibility/typing rules (packages vs project-base vs utils), and documentation best practices. Read it before writing or modifying PHP so your code matches the codebase.

Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Monorepo tooling. It works with PHP. The repository describes itself as: Main repository for maintaining Shopsys Platform packages. Open for ISSUES and PULL REQUESTS.

When your agent uses it

  • Tasks that involve Monorepo tooling

Example prompts

  • “/coding-conventions”

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Remove it — truly dead code is deleted, together with callees that die with it.
  2. Whole-class entry (identifier + path, no message) in the "whole api classes" section — the class belongs to an API category whose whole…
  3. Member entry (identifier + exact-message regex + path) in the "individual members" section — the flagged member is intentional downstream…
  4. Extend or add a usage provider in shopsys/coding-standards (packages/coding-standards/src/Phpstan/) — when a whole dynamic-call channel is…

What it can do on your machine

Read from SKILL.md and the folder at commit 494a8a6. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Coding Conventions loads about 1.1k tokens when it runs. Until then it costs about 82 tokens; SKILL.md has 526 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~82
When it runs · the whole SKILL.md, loaded when a task matches
~1.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 526 words (~1,070 tokens).

“The principles are authored from the project perspective and are the same here. Read the canonical:”

— opening of SKILL.md by shopsys, Custom licence
name
coding-conventions

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .agents/skills/coding-conventions of shopsys/shopsys.

Open the folder on GitHubat commit 494a8a6

Compare with similar skills

Coding Conventions next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Coding Conventions compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Coding Conventions this skillshopsys/shopsys350—~1.1kAutomated safety check: PassCustom licence
Basercms Core Plugin Convertbaserproject/basercms190—~3.1kAutomated safety check: PassMIT
Nx Importnrwl/nx29k5 repos~3.5kAutomated safety check: PassMIT
Nx Workspacenomcopter/react-mosaic4.8k7 repos~1.9kAutomated safety check: PassCustom licence
Electron Multi-Process ArchitectureiOfficeAI/AionUi33k1 repos~1.8kAutomated safety check: PassApache-2.0
Nx Run Tasksnomcopter/react-mosaic4.8k7 repos~613Automated safety check: PassCustom licence

Similar skills

  • Basercms Core Plugin Convert

    baserproject/basercms

    baserCMS の「通常プラグイン(サードパーティ/単体配布)」を monorepo の「コアプラグイン」に昇格させる手順。「コアプラグインに変更」「コアプラグイン化」「通常プラグインをコアに昇格」「monorepo に取り込む」等のときに参照する。プラグイン名の規約変更(bc- プレフィックス付与・CamelCase→ハイフン区切り)、.git/シンボリックリンク/standalone…

    190 GitHub stars~3.1k tokensUpdated 2 days ago
    DevelopmentAuto-check passed
  • Nx Import

    nrwl/nx

    Import, merge, or combine repositories into an Nx workspace using nx import.

    29k GitHub starsUsed in 5 repos~3.5k tokens
    DevelopmentAuto-check passed
  • Nx Workspace

    nomcopter/react-mosaic

    Explore and understand Nx workspaces. An agent skill from nomcopter/react-mosaic.

    4.8k GitHub starsUsed in 7 repos~1.9k tokens
    DevelopmentAuto-check passed
  • Tells the agent where new code belongs in an Electron multi-process project and which APIs each process may use, with rules for new bridges, services, agents and workers.

    33k GitHub starsUsed in 1 repo~1.8k tokens
    DevelopmentAuto-check passed
  • Nx Run Tasks

    nomcopter/react-mosaic

    Helps with running tasks in an Nx workspace. An agent skill from nomcopter/react-mosaic.

    4.8k GitHub starsUsed in 7 repos~613 tokens
    DevelopmentAuto-check passed
  • WooCommerce Code Review

    woocommerce/woocommerce

    Reviews WooCommerce code changes against the project's standards, flagging backend PHP architecture, naming, documentation, data integrity and testing violations.

    11k GitHub starsUsed in 3 repos~1.1k tokens
    DevelopmentAuto-check passed

More from shopsys/shopsys

All 46 skills in this repo
  • Adhoc PR

    shopsys/shopsys

    Ad-hoc Pull Request Publisher — commits the current changes, pushes the branch, opens a GitHub pull request against the repository's default branch, and creates a matching SSP Jira issue in the…

    350 GitHub stars~2.3k tokensUpdated today
    Auto-check passed
  • Commit

    shopsys/shopsys

    Interactive commit workflow — analyzes all uncommitted changes, proposes atomic, logically grouped commits with messages following commit-conventions, and executes them only after the user approves…

    350 GitHub stars~771 tokensUpdated today
    Auto-check: notes
  • Create Enum

    shopsys/shopsys

    Create a Shopsys-style enum (a class extending AbstractEnum with public typed constants, NOT a native PHP enum).

    350 GitHub stars~1.9k tokensUpdated today
    Auto-check passed
  • Docs Researcher

    shopsys/shopsys

    Searches and analyzes documentation to provide relevant information for development tasks.

    350 GitHub stars~1.5k tokensUpdated today
    Auto-check passed
  • PR Comments

    shopsys/shopsys

    Work with GitHub PR review threads — list unresolved comments as a digest (who is waiting on whom), reply to threads, and resolve/unresolve them.

    350 GitHub stars~2k tokensUpdated today
    Auto-check passed
  • PR Description

    shopsys/shopsys

    Generates a PR description focused on business value using the project's PR template.

    350 GitHub stars~1.7k tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about Coding Conventions

What does Coding Conventions do?

Coding principles and conventions for the Shopsys monorepo — DRY/KISS/reuse, comment and docblock quality, test-code rules, the per-folder visibility/typing rules (packages vs project-base vs…. Coding Conventions is an agent skill from shopsys/shopsys. Coding principles and conventions for the Shopsys monorepo — DRY/KISS/reuse, comment and docblock quality, test-code rules, the per-folder visibility/typing rules (packages vs project-base vs utils), and documentation best practices.

When should I use Coding Conventions?

Coding Conventions fits situations like: tasks that involve Monorepo tooling.

How do I install Coding Conventions in Claude Code?

Run `npx skills add shopsys/shopsys --skill coding-conventions -a claude-code`. Or copy the skill folder (.agents/skills/coding-conventions in shopsys/shopsys) into .claude/skills/coding-conventions in your project. Claude Code loads it when a task matches its description.

How do I install Coding Conventions in Codex?

Run `npx skills add shopsys/shopsys --skill coding-conventions -a codex`. Or copy the skill folder (.agents/skills/coding-conventions in shopsys/shopsys) into .agents/skills/coding-conventions in your project. Codex loads it when a task matches its description.

Can I use Coding Conventions in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add shopsys/shopsys --skill coding-conventions -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/coding-conventions, .gemini/skills/coding-conventions, .github/skills/coding-conventions and .opencode/skills/coding-conventions in your project.

What does Coding Conventions need to run?

SKILL.md names no scripts, command-line tools or credentials: Coding Conventions is instructions for the agent only.

Does Coding Conventions access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Coding Conventions safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Coding Conventions use?

Coding Conventions has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Coding Conventions use?

About 1.1k tokens (SKILL.md is roughly 4.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Coding Conventions?

Skills that share tags, products or a category with Coding Conventions: Basercms Core Plugin Convert (baserproject/basercms, 190 stars), Nx Import (nrwl/nx, 29k stars), Nx Workspace (nomcopter/react-mosaic, 4.8k stars) and Electron Multi-Process Architecture (iOfficeAI/AionUi, 33k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Coding Conventions?

shopsys (a GitHub organization) maintains it in shopsys/shopsys, which has 350 GitHub stars. The repository holds 46 skills in this directory. The repository was last updated on October 7, 2026.

Source: shopsys/shopsys on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.