Agent skill

Coding Conventions

by shopsys in shopsys/shopsys

Coding principles and conventions for this Shopsys project — DRY/KISS/reuse, comment and docblock quality, test-code rules, the project visibility/typing rules, and documentation best practices.

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/project-base/.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.6k tokens
SKILL.md length
587 words
Files
1
Skills in repo
46
Repo updated
First seen
Licence
Custom licence

At a glance

Coding principles and conventions for this Shopsys project — DRY/KISS/reuse, comment and docblock quality, test-code rules, the project visibility/typing rules, and documentation best practices.

  • Development work in your project
  • SKILL.md covers Core principles, Comments — quality over quantity, DocBlocks — always specify… and Test-code rules, plus 2 more sections
  • 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 this Shopsys project — DRY/KISS/reuse, comment and docblock quality, test-code rules, the project visibility/typing rules, and documentation best practices. Read it before writing or modifying PHP so your code matches the codebase.

Its SKILL.md is about 1.6k 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. 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

  • Development work in your project

Example prompts

  • “/coding-conventions”

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 (its code samples are php).

    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.6k tokens when it runs. Until then it costs about 72 tokens; SKILL.md has 587 words of instructions outside code blocks.

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

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 587 words (~1,650 tokens).

“Follow these whenever you write or modify code in this project.”

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

Read the full SKILL.md on GitHub

Files

Just SKILL.md in project-base/.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.6kAutomated safety check: PassCustom licence
WooCommerce Code Reviewwoocommerce/woocommerce11k3 repos~1.1kAutomated safety check: PassCustom licence
Skill Doli Code ReviewDolibarr/dolibarr7.7k1 repos~1.1kAutomated safety check: PassMIT
Bug Triagesymfony/symfony31k—~1.9kAutomated safety check: PassMIT
Merge Upsymfony/symfony31k—~4kAutomated safety check: PassMIT
PR Mergesymfony/symfony31k—~3.1kAutomated safety check: PassMIT

Similar skills

  • 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
  • Skill Doli Code Review

    Dolibarr/dolibarr

    Reviews Dolibarr PHP code for compliance with coding standards and security best practices, and fixes identified issues.

    7.7k GitHub starsUsed in 1 repo~1.1k tokens
    DevelopmentAuto-check passed
  • Bug Triage

    symfony/symfony

    Decide whether open Bug PRs target the correct branch. An agent skill from symfony/symfony.

    31k GitHub stars~1.9k tokensUpdated today
    DevelopmentAuto-check passed
  • Merge Up

    symfony/symfony

    Cascade-merge maintained Symfony branches from oldest to newest (e.g.

    31k GitHub stars~4k tokensUpdated today
    DevelopmentAuto-check passed
  • PR Merge

    symfony/symfony

    Merge a reviewed pull request the way the Symfony core team does: one --no-ff merge commit per PR, whose message archives the whole discussion, with the review gates checked first.

    31k GitHub stars~3.1k tokensUpdated today
    DevelopmentAuto-check passed
  • Wp Interactivity API

    Automattic/agent-skills

    A skill your agent uses when building or debugging WordPress Interactivity API features (data-wp- directives, @wordpress/interactivity store/state/actions, block viewScriptModule integration…

    211 GitHub starsUsed in 2 repos~1.5k 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 this Shopsys project — DRY/KISS/reuse, comment and docblock quality, test-code rules, the project visibility/typing rules, and documentation best practices. Coding Conventions is an agent skill from shopsys/shopsys. Coding principles and conventions for this Shopsys project — DRY/KISS/reuse, comment and docblock quality, test-code rules, the project visibility/typing rules, and documentation best practices.

When should I use Coding Conventions?

Coding Conventions fits situations like: development work in your project.

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 (project-base/.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 (project-base/.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.6k tokens (SKILL.md is roughly 6.6k 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: WooCommerce Code Review (woocommerce/woocommerce, 11k stars), Skill Doli Code Review (Dolibarr/dolibarr, 7.7k stars), Bug Triage (symfony/symfony, 31k stars) and Merge Up (symfony/symfony, 31k 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.