Agent skill

Project Guidelines Example

by loulanyue in loulanyue/awesome-claude-notes

“基于真实生产应用的示例项目特定技能模板。”

— description from SKILL.md by loulanyue
MITAuto-check: notesTesting & QA

Install Project Guidelines Example

skills CLI
$ npx skills add loulanyue/awesome-claude-notes --skill project-guidelines-example -a claude-code

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

GitHub CLI
$ gh skill install loulanyue/awesome-claude-notes project-guidelines-example --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/loulanyue/awesome-claude-notes.git skills-src && mkdir -p .claude/skills && cp -r skills-src/docs/zh-CN/skills/project-guidelines-example .claude/skills/project-guidelines-example && 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
project-guidelines-example
GitHub stars
272
Token cost
~2k tokens
SKILL.md length
139 words
Files
1
Skills in repo
9
Repo updated
First seen
Licence
MIT

At a glance

  • Works in 8 steps: 在代码、注释或文档中不使用表情符号 → 不可变性 - 永不改变对象或数组 → 测试驱动开发 (TDD) - 在实现之前编写测试 → …
  • SKILL.md covers 何时使用, 架构概述, 文件结构 and 代码模式, plus 6 more sections
  • Calls npm, poetry and gcloud; reaches xxx.supabase.co; needs NEXT_PUBLIC_SUPABASE_ANON_KEY and ANTHROPIC_API_KEY

About this skill

Project Guidelines Example is a skill in loulanyue/awesome-claude-notes (272 stars). Its SKILL.md is about 2k tokens. Licence: MIT.

Workflow steps

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

  1. 在代码、注释或文档中不使用表情符号
  2. 不可变性 - 永不改变对象或数组
  3. 测试驱动开发 (TDD) - 在实现之前编写测试
  4. 最低 80% 覆盖率
  5. 许多小文件 - 典型 200-400 行,最多 800 行
  6. 在生产代码中不使用 console.log
  7. 使用 try/catch 进行适当的错误处理
  8. 使用 Pydantic/Zod 进行输入验证

What it can do on your machine

Read from SKILL.md and the folder at commit 866b55b. 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

    Shell commands in SKILL.md call:

    • npm
    • poetry
    • gcloud

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

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • xxx.supabase.co

    Also links to:

    • zenith.chat

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

  • Credentials

    Names these keys or tokens, usually read from environment variables:

    • NEXT_PUBLIC_SUPABASE_ANON_KEY
    • ANTHROPIC_API_KEY
    • SUPABASE_KEY

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

Context cost

Project Guidelines Example loads about 2k tokens when it runs. Until then it costs about 12 tokens; SKILL.md has 139 words of instructions outside code blocks.

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

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: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NoteMentions a .env fileSKILL.md:323
    # Frontend (.env.local)
  • NoteMentions a .env fileSKILL.md:328
    # Backend (.env)

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

The full file from loulanyue/awesome-claude-notes at commit 866b55b, republished under its MIT licence (© loulanyue). 139 words, ~1,974 tokens.

Download SKILL.mdSave it as .claude/skills/project-guidelines-example/SKILL.md (or your agent's skills folder).
name
project-guidelines-example
description
基于真实生产应用的示例项目特定技能模板。
source_path
skills/project-guidelines-example/SKILL.md
origin
ECC

项目指南技能(示例)

这是一个项目特定技能的示例。将其用作您自己项目的模板。

基于一个真实的生产应用程序:Zenith - 由 AI 驱动的客户发现平台。

何时使用

在为其设计的特定项目上工作时,请参考此技能。项目技能包含:

  • 架构概述
  • 文件结构
  • 代码模式
  • 测试要求
  • 部署工作流

架构概述

技术栈:

  • 前端: Next.js 15 (App Router), TypeScript, React
  • 后端: FastAPI (Python), Pydantic 模型
  • 数据库: Supabase (PostgreSQL)
  • AI: Claude API,支持工具调用和结构化输出
  • 部署: Google Cloud Run
  • 测试: Playwright (E2E), pytest (后端), React Testing Library

服务:

┌─────────────────────────────────────────────────────────────┐
│                         前端                               │
│  Next.js 15 + TypeScript + TailwindCSS                     │
│  部署平台:Vercel / Cloud Run                              │
└─────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────┐
│                         后端                               │
│  FastAPI + Python 3.11 + Pydantic                          │
│  部署平台:Cloud Run                                       │
└─────────────────────────────────────────────────────────────┘
                              │
              ┌───────────────┼───────────────┐
              ▼               ▼               ▼
        ┌──────────┐   ┌──────────┐   ┌──────────┐
        │ Supabase │   │  Claude  │   │  Redis   │
        │ 数据库   │   │   API    │   │  缓存    │
        └──────────┘   └──────────┘   └──────────┘

文件结构

project/
├── frontend/
│   └── src/
│       ├── app/              # Next.js 应用路由页面
│       │   ├── api/          # API 路由
│       │   ├── (auth)/       # 受身份验证保护的路由
│       │   └── workspace/    # 主应用工作区
│       ├── components/       # React 组件
│       │   ├── ui/           # 基础 UI 组件
│       │   ├── forms/        # 表单组件
│       │   └── layouts/      # 布局组件
│       ├── hooks/            # 自定义 React 钩子
│       ├── lib/              # 工具库
│       ├── types/            # TypeScript 类型定义
│       └── config/           # 配置文件
│
├── backend/
│   ├── routers/              # FastAPI 路由处理器
│   ├── models.py             # Pydantic 模型
│   ├── main.py               # FastAPI 应用入口
│   ├── auth_system.py        # 身份验证模块
│   ├── database.py           # 数据库操作
│   ├── services/             # 业务逻辑层
│   └── tests/                # pytest 测试
│
├── deploy/                   # 部署配置
├── docs/                     # 文档
└── scripts/                  # 工具脚本

代码模式

API 响应格式 (FastAPI)
python
from pydantic import BaseModel
from typing import Generic, TypeVar, Optional

T = TypeVar('T')

class ApiResponse(BaseModel, Generic[T]):
    success: bool
    data: Optional[T] = None
    error: Optional[str] = None

    @classmethod
    def ok(cls, data: T) -> "ApiResponse[T]":
        return cls(success=True, data=data)

    @classmethod
    def fail(cls, error: str) -> "ApiResponse[T]":
        return cls(success=False, error=error)
前端 API 调用 (TypeScript)
typescript
interface ApiResponse<T> {
  success: boolean
  data?: T
  error?: string
}

async function fetchApi<T>(
  endpoint: string,
  options?: RequestInit
): Promise<ApiResponse<T>> {
  try {
    const response = await fetch(`/api${endpoint}`, {
      ...options,
      headers: {
        'Content-Type': 'application/json',
        ...options?.headers,
      },
    })

    if (!response.ok) {
      return { success: false, error: `HTTP ${response.status}` }
    }

    return await response.json()
  } catch (error) {
    return { success: false, error: String(error) }
  }
}
Claude AI 集成 (结构化输出)
python
from anthropic import Anthropic
from pydantic import BaseModel

class AnalysisResult(BaseModel):
    summary: str
    key_points: list[str]
    confidence: float

async def analyze_with_claude(content: str) -> AnalysisResult:
    client = Anthropic()

    response = client.messages.create(
        model="claude-sonnet-4-5-20250514",
        max_tokens=1024,
        messages=[{"role": "user", "content": content}],
        tools=[{
            "name": "provide_analysis",
            "description": "Provide structured analysis",
            "input_schema": AnalysisResult.model_json_schema()
        }],
        tool_choice={"type": "tool", "name": "provide_analysis"}
    )

    # Extract tool use result
    tool_use = next(
        block for block in response.content
        if block.type == "tool_use"
    )

    return AnalysisResult(**tool_use.input)
自定义 Hooks (React)
typescript
import { useState, useCallback } from 'react'

interface UseApiState<T> {
  data: T | null
  loading: boolean
  error: string | null
}

export function useApi<T>(
  fetchFn: () => Promise<ApiResponse<T>>
) {
  const [state, setState] = useState<UseApiState<T>>({
    data: null,
    loading: false,
    error: null,
  })

  const execute = useCallback(async () => {
    setState(prev => ({ ...prev, loading: true, error: null }))

    const result = await fetchFn()

    if (result.success) {
      setState({ data: result.data!, loading: false, error: null })
    } else {
      setState({ data: null, loading: false, error: result.error! })
    }
  }, [fetchFn])

  return { ...state, execute }
}

测试要求

后端 (pytest)
bash
# Run all tests
poetry run pytest tests/

# Run with coverage
poetry run pytest tests/ --cov=. --cov-report=html

# Run specific test file
poetry run pytest tests/test_auth.py -v

测试结构:

python
import pytest
from httpx import AsyncClient
from main import app

@pytest.fixture
async def client():
    async with AsyncClient(app=app, base_url="http://test") as ac:
        yield ac

@pytest.mark.asyncio
async def test_health_check(client: AsyncClient):
    response = await client.get("/health")
    assert response.status_code == 200
    assert response.json()["status"] == "healthy"
前端 (React Testing Library)
bash
# Run tests
npm run test

# Run with coverage
npm run test -- --coverage

# Run E2E tests
npm run test:e2e

测试结构:

typescript
import { render, screen, fireEvent } from '@testing-library/react'
import { WorkspacePanel } from './WorkspacePanel'

describe('WorkspacePanel', () => {
  it('renders workspace correctly', () => {
    render(<WorkspacePanel />)
    expect(screen.getByRole('main')).toBeInTheDocument()
  })

  it('handles session creation', async () => {
    render(<WorkspacePanel />)
    fireEvent.click(screen.getByText('New Session'))
    expect(await screen.findByText('Session created')).toBeInTheDocument()
  })
})

部署工作流

部署前检查清单
  • [ ] 所有测试在本地通过
  • [ ] npm run build 成功 (前端)
  • [ ] poetry run pytest 通过 (后端)
  • [ ] 没有硬编码的密钥
  • [ ] 环境变量已记录
  • [ ] 数据库迁移就绪
部署命令
bash
# Build and deploy frontend
cd frontend && npm run build
gcloud run deploy frontend --source .

# Build and deploy backend
cd backend
gcloud run deploy backend --source .
环境变量
bash
# Frontend (.env.local)
NEXT_PUBLIC_API_URL=https://api.example.com
NEXT_PUBLIC_SUPABASE_URL=https://xxx.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJ...

# Backend (.env)
DATABASE_URL=postgresql://...
ANTHROPIC_API_KEY=sk-ant-...
SUPABASE_URL=https://xxx.supabase.co
SUPABASE_KEY=eyJ...

关键规则

  1. 在代码、注释或文档中不使用表情符号
  2. 不可变性 - 永不改变对象或数组
  3. 测试驱动开发 (TDD) - 在实现之前编写测试
  4. 最低 80% 覆盖率
  5. 许多小文件 - 典型 200-400 行,最多 800 行
  6. 在生产代码中不使用 console.log
  7. 使用 try/catch 进行适当的错误处理
  8. 使用 Pydantic/Zod 进行输入验证

相关技能

  • coding-standards.md - 通用编码最佳实践
  • backend-patterns.md - API 和数据库模式
  • frontend-patterns.md - React 和 Next.js 模式
  • tdd-workflow/ - 测试驱动开发方法论

原文

导航

© loulanyue, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in docs/zh-CN/skills/project-guidelines-example of loulanyue/awesome-claude-notes.

Open the folder on GitHubat commit 866b55b

Compare with similar skills

Project Guidelines Example 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.

Project Guidelines Example compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Project Guidelines Example this skillloulanyue/awesome-claude-notes272—~2kAutomated safety check: NotesMIT
Integration Tests for pRESTprest/prest4.6k—~1.1kAutomated safety check: PassMIT
Testing Best Practicesanonaddy/anonaddy4.9k5 repos~1kAutomated safety check: PassMIT
Cloud Agents Starterscalar/scalar16k—~1.4kAutomated safety check: PassMIT
Test Weave Router with Codexweave-os/router5.6k—~4.7kAutomated safety check: NotesApache-2.0
New Event Sourceaws/aws-lambda-dotnet1.7k—~3kAutomated safety check: PassApache-2.0

Similar skills

  • Guides writing and reviewing pREST Docker-based integration tests so every HTTP request is explained by step comments or table-driven descriptions.

    4.6k GitHub stars~1.1k tokensUpdated today
    Testing & QAAuto-check passed
  • Testing Best Practices

    anonaddy/anonaddy

    Laravel test design and review. An agent skill from anonaddy/anonaddy.

    4.9k GitHub starsUsed in 5 repos~1k tokens
    Testing & QAAuto-check passed
  • Minimal starter runbook for cloud agents to install dependencies, run packages, execute tests, and troubleshoot the Scalar monorepo quickly.

    16k GitHub stars~1.4k tokensUpdated today
    Testing & QAAuto-check passed
  • Local test harness for the Weave router: a docker compose stack plus codex exec runs that confirm how Codex requests are routed, translated and marked.

    5.6k GitHub stars~4.7k tokensUpdated today
    Testing & QAAuto-check: notes
  • New Event Source

    aws/aws-lambda-dotnet

    Official

    Add a new AWS event source attribute (e.g., Kinesis, Kafka, MQ) to the Lambda .NET Annotations framework, including the attribute class, source generator integration, CloudFormation writer, unit…

    1.7k GitHub stars~3k tokensUpdated today
    Testing & QAAuto-check passed
  • Studio Mock API Tests

    supabase/supabase

    Official

    Component tests for Supabase Studio that mock API requests at the network layer with MSW.

    111k GitHub stars~3k tokensUpdated today
    Testing & QAAuto-check passed

More from loulanyue/awesome-claude-notes

All 9 skills in this repo
  • Claude API

    loulanyue/awesome-claude-notes

    Anthropic Claude API patterns for Python and TypeScript. An agent skill from loulanyue/awesome-claude-notes.

    272 GitHub starsUsed in 2 repos~2.1k tokens
    Auto-check passed
  • Team Builder

    loulanyue/awesome-claude-notes

    Interactive agent picker for composing and dispatching parallel teams

    272 GitHub starsUsed in 3 repos~1.6k tokens
    Auto-check passed
  • Claude Devfleet

    loulanyue/awesome-claude-notes

    Orchestrate multi-agent coding tasks via Claude DevFleet — plan projects, dispatch parallel agents in isolated worktrees, monitor progress, and read structured reports.

    272 GitHub starsUsed in 2 repos~1.4k tokens
    Auto-check passed
  • Configure Ecc

    loulanyue/awesome-claude-notes

    Interactive installer for awesome claude notes — guides users through selecting and installing skills and rules to user-level or project-level directories, verifies paths, and optionally optimizes…

    272 GitHub starsUsed in 2 repos~3.9k tokens
    Auto-check passed
  • Claude API

    loulanyue/awesome-claude-notes

    Anthropic Claude API 的 Python 和 TypeScript 使用模式。涵盖 Messages API、流式处理、工具使用、视觉功能、扩展思维、批量处理、提示缓存和 Claude Agent SDK。适用于使用 Claude API 或 Anthropic SDK 构建应用程序的场景。

    272 GitHub starsUsed in 1 repo~1.9k tokens
    Auto-check passed
  • Configure Ecc

    loulanyue/awesome-claude-notes

    awesome claude notes のインタラクティブなインストーラー — スキルとルールの選択とインストールをユーザーレベルまたはプロジェクトレベルのディレクトリへガイドし、パスを検証し、必要に応じてインストールされたファイルを最適化します。

    272 GitHub stars~2.2k tokensUpdated 4 days ago
    Auto-check passed

Questions about Project Guidelines Example

How do I install Project Guidelines Example in Claude Code?

Run `npx skills add loulanyue/awesome-claude-notes --skill project-guidelines-example -a claude-code`. Or copy the skill folder (docs/zh-CN/skills/project-guidelines-example in loulanyue/awesome-claude-notes) into .claude/skills/project-guidelines-example in your project. Claude Code loads it when a task matches its description.

How do I install Project Guidelines Example in Codex?

Run `npx skills add loulanyue/awesome-claude-notes --skill project-guidelines-example -a codex`. Or copy the skill folder (docs/zh-CN/skills/project-guidelines-example in loulanyue/awesome-claude-notes) into .agents/skills/project-guidelines-example in your project. Codex loads it when a task matches its description.

Can I use Project Guidelines Example 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 loulanyue/awesome-claude-notes --skill project-guidelines-example -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/project-guidelines-example, .gemini/skills/project-guidelines-example, .github/skills/project-guidelines-example and .opencode/skills/project-guidelines-example in your project.

What does Project Guidelines Example need to run?

Going by SKILL.md and its folder, Project Guidelines Example needs the command-line tools its instructions call (npm, poetry and gcloud) and credentials named NEXT_PUBLIC_SUPABASE_ANON_KEY, ANTHROPIC_API_KEY and SUPABASE_KEY.

Does Project Guidelines Example access the network?

SKILL.md names 2 domains. In commands or code: xxx.supabase.co; the agent is likely to contact it when it follows the instructions. As links in the text: zenith.chat. This is read from the text; nothing was executed.

Is Project Guidelines Example safe to install?

Our automated static check of SKILL.md found notes only (mentions a .env file), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Project Guidelines Example use?

Project Guidelines Example is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Project Guidelines Example use?

About 2k tokens (SKILL.md is roughly 7.9k 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 Project Guidelines Example?

Skills that share tags, products or a category with Project Guidelines Example: Integration Tests for pREST (prest/prest, 4.6k stars), Testing Best Practices (anonaddy/anonaddy, 4.9k stars), Cloud Agents Starter (scalar/scalar, 16k stars) and Test Weave Router with Codex (weave-os/router, 5.6k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Project Guidelines Example?

loulanyue (a GitHub user) maintains it in loulanyue/awesome-claude-notes, which has 272 GitHub stars. The repository holds 9 skills in this directory. The repository was last updated on October 5, 2026.

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