project-guidelines-example

project-guidelines-example is a skill for Claude Code, Codex from x-cmd/skill. It costs 17 tokens per session (2,176 once invoked), scanned A, a copy of cc-skill-project-guidelines-example, Apache-2.0.

A sample set of project-specific instructions for an AI coding assistant. It shows how to document a project's architecture, code layout, patterns, testing, and deployment process.

In plain words
What is it for?
Creating a guidelines file for a specific application and documenting its technology choices, workflows, and testing requirements.
Why use it?
It gives an assistant the project context it needs to follow local rules instead of relying only on general coding knowledge.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Creating a guidelines file for a specific application and documenting its technology choices, workflows, and testing requirements.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/x-cmd/skill/project-guidelines-example
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.

Any agent
npx skills add x-cmd/skill --skill project-guidelines-example
Clone the repo
git clone --depth 1 https://github.com/x-cmd/skill

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-guidelines-example

README.md
[![agentmods](https://agentmods.dev/badge/skills/x-cmd/skill/project-guidelines-example/github.svg)](https://agentmods.dev/skills/x-cmd/skill/project-guidelines-example)
Your own site
<a href="https://agentmods.dev/skills/x-cmd/skill/project-guidelines-example"><img src="https://agentmods.dev/badge/skills/x-cmd/skill/project-guidelines-example/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for project-guidelines-example

Your own site · 80×15
<a href="https://agentmods.dev/skills/x-cmd/skill/project-guidelines-example"><img src="https://agentmods.dev/badge/skills/x-cmd/skill/project-guidelines-example.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 17 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,176 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin 86% copy Near-identical to another mod 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.1 $0.00017 $0.02176
Opus 5.5 $0.00007 $0.00870
Sonnet 5.5 $0.00003 $0.00435
Haiku 4.5 $0.00002 $0.00218

Measured 1mo ago against content hash 68a3764074ab, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

project-guidelines-example 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 1mo ago.

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

This is a copy

86% identical to cc-skill-project-guidelines-example — 9 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

data/affaanmustafa/project-guidelines-example/SKILL.md · 350 lines

How it starts

The opening of the file, as written. The whole thing — 350 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Project Guidelines Skill (Example)

This is an example of a project-specific skill. Use this as a template for your own projects.

Based on a real production application: Zenith - AI-powered customer discovery platform.

When to Use

Reference this skill when working on the specific project it's designed for. Project skills contain:

  • Architecture overview
  • File structure
  • Code patterns
  • Testing requirements
  • Deployment workflow

Architecture Overview

Tech Stack:

  • Frontend: Next.js 15 (App Router), TypeScript, React
  • Backend: FastAPI (Python), Pydantic models
  • Database: Supabase (PostgreSQL)
  • AI: Claude API with tool calling and structured output
  • Deployment: Google Cloud Run
  • Testing: Playwright (E2E), pytest (backend), React Testing Library

Services:

┌─────────────────────────────────────────────────────────────┐
│                         Frontend                            │
│  Next.js 15 + TypeScript + TailwindCSS                     │
│  Deployed: Vercel / Cloud Run                              │
└─────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────┐
│                         Backend                             │
│  FastAPI + Python 3.11 + Pydantic                          │
│  Deployed: Cloud Run                                       │
└─────────────────────────────────────────────────────────────┘
                              │
              ┌───────────────┼───────────────┐
              ▼               ▼               ▼
        ┌──────────┐   ┌──────────┐   ┌──────────┐
        │ Supabase │   │  Claude  │   │  Redis   │
        │ Database │   │   API    │   │  Cache   │
        └──────────┘   └──────────┘   └──────────┘

File Structure

project/
├── frontend/
│   └── src/
│       ├── app/              # Next.js app router pages
│       │   ├── api/          # API routes
│       │   ├── (auth)/       # Auth-protected routes
│       │   └── workspace/    # Main app workspace
│       ├── components/       # React components
│       │   ├── ui/           # Base UI components
│       │   ├── forms/        # Form components
│       │   └── layouts/      # Layout components
│       ├── hooks/            # Custom React hooks
│       ├── lib/              # Utilities
│       ├── types/            # TypeScript definitions
│       └── config/           # Configuration
│
├── backend/
│   ├── routers/              # FastAPI route handlers
│   ├── models.py             # Pydantic models
│   ├── main.py               # FastAPI app entry
│   ├── auth_system.py        # Authentication
│   ├── database.py           # Database operations
│   ├── services/             # Business logic
│   └── tests/                # pytest tests
│
├── deploy/                   # Deployment configs
├── docs/                     # Documentation
└── scripts/                  # Utility scripts

Read the full file on GitHub · 350 lines

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. 1mo ago First seen · 350 lines · 17 tokens per session scan A 68a3764074ab

Subscribe to this mod's changes

project-guidelines-example is a skill published in the GitHub repository x-cmd/skill (26 stars, last pushed 3mo ago), licensed Apache-2.0. It adds 17 tokens to every session and 2,176 once invoked, about $0.0001 per session on Opus 5.5. A static security scan graded it A with 0 findings. It is 86% identical to cc-skill-project-guidelines-example, differing in 9 lines, and is treated as a copy.