Agent skill · software engineering · affaan-m
project-guidelines-example
Project-specific skill template covering architecture, patterns, testing, and deployment guidance.
Why this skill is useful
Provides detailed project architecture, file structure, and code patterns specific to a proprietary tech stack that the AI wouldn't reliably generate on its own.
What it needs
Requires fastapi, next.js, playwright, pytest, react-testing-library, supabase installed locally. About 3k tokens when loaded. Last updated 2026-08-06. 238,342 stars on the source repository.
What this skill does
プロジェクトガイドラインスキル（例） これはプロジェクト固有のスキルの例です。自分のプロジェクトのテンプレートとして使用してください。 実際の本番アプリケーションに基づいています：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 サービス： --- ファイル構造 --- コードパターン APIレスポンス形式 (FastAPI) フロントエンドAPI呼び出し (TypeScript) Claude AI統合（構造化出力） カスタムフック (React) --- テスト要件 バックエンド (pytest) テスト構造： フロントエンド (React Testing Library) テスト構造： --- デプロイメントワークフロー デプロイ前チェックリスト [ ] すべてのテストがローカルで成功 [ ] npm run build が成功（フロントエンド） [ ] poetry run pytest が成功（バックエンド） [ ] ハードコードされたシークレットなし [ ] 環境変数がドキュメント化されている [ ] データベースマイグレーションが準備されている デプロイメントコマンド 環境変数 --- 重要なルール 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/ - テスト駆動開発の方法論
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills affaan-m/project-guidelines-example