project-conventions

project-conventions is a skill for Claude Code, Codex from github/gh-aw. It costs 12 tokens per session (346 once invoked), scanned A, original, MIT.

A starter guide for documenting conventions used in a specific codebase, such as error handling, testing, style, and file structure.

In plain words
What is it for?
Filling in project rules, adding examples, and documenting patterns agents should follow or avoid.
Why use it?
It gives coding agents a single reference for project-specific practices. The supplied version is only a template and contains no actual conventions.

Skill for Claude CodeCodex

About the project

GitHub Agentic Workflows is a GitHub CLI extension that lets developers define AI-assisted repository automation in Markdown and run it through GitHub Actions. It is intended for tasks requiring interpretation or reasoning, such as issue triage, pull-request review, CI investigation, documentation maintenance, and dependency analysis. The catalogue entries provide skills and agents for working with these workflows.

github/gh-aw · 5,091 stars · on GitHub

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/github/gh-aw/project-conventions
Any agent
npx skills add github/gh-aw --skill project-conventions
Clone the repo
git clone --depth 1 https://github.com/github/gh-aw

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for project-conventions

README.md
[![agentmods](https://agentmods.dev/badge/skills/github/gh-aw/project-conventions.svg)](https://agentmods.dev/skills/github/gh-aw/project-conventions)
Your own site
<a href="https://agentmods.dev/skills/github/gh-aw/project-conventions"><img src="https://agentmods.dev/badge/skills/github/gh-aw/project-conventions.svg" alt="Measured on agentmods" height="20"></a>
Per session 12 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 346 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00012 $0.00346
Opus 5 $0.00006 $0.00173
Sonnet 5 $0.00002 $0.00069
Haiku 4.5 $0.00001 $0.00035

Measured yesterday against content hash 5feb0b864a03, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

project-conventions scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

Copies of this mod

8 near-identical copies found in the catalogue:

.squad/templates/skills/project-conventions/SKILL.md · 57 lines

What it actually says

Context

This is a starter template. Replace the placeholder patterns below with your actual project conventions. Skills train agents on codebase-specific practices — accurate documentation here improves agent output quality.

Patterns

[Pattern Name]

Describe a key convention or practice used in this codebase. Be specific about what to do and why.

Error Handling

Testing

Code Style

File Structure

Examples

// Add code examples that demonstrate your conventions

Anti-Patterns

  • [Anti-pattern] — Explanation of what not to do and why.
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 57 lines · 12 tokens per session scan A 5feb0b864a03

Subscribe to this mod's changes

project-conventions is a skill published in the GitHub repository github/gh-aw (5,091 stars, last pushed yesterday), licensed MIT. It adds 12 tokens to every session and 346 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Related

Other skills, from other repositories

c-github

Interact with GitHub using the gh CLI and jq. Manage PRs, issues, repositories, and Actions workflows. Make raw API calls with gh api for anything not covered by built-in commands.

daxaur/openpaw · 48 tokens

watch-pr

Watch a GitHub pull request for CI status, reviews, comments, merge conflicts, and terminal states using the gh-watch extension. Use when the user wants to monitor a PR, wait for CI, or track PR progress.

justincampbell/gh-watch · 48 tokens

watch-tag

Watch a GitHub repository for new tags using the gh-watch extension. Use when the user wants to be notified when a tag is created, when a release is cut, or when a tag that includes a specific commit appears (e.g. "tell me when my merge ships in a release").

justincampbell/gh-watch · 62 tokens

watch-branch

Watch a GitHub branch for new commits using the gh-watch extension. Use when the user wants to be notified when new commits are pushed to a branch, monitor main for merges, or track branch activity.

justincampbell/gh-watch · 45 tokens

watch-commit

Watch a GitHub commit for CI status changes using the gh-watch extension. Use when the user wants to monitor a commit's CI checks, wait for a build to finish, or track CI progress on a specific SHA.

justincampbell/gh-watch · 48 tokens

update-architecture-docs

Generate or update the architecture documentation in docs/content/architecture/. Use on "update architecture docs", "generate architecture documentation", "regenerate architecture docs", or after any structural change to the codebase.

AlexSkrypnyk/scaffold · 46 tokens