# Project Guidelines Example

> Example project-specific skill template. Use as a starting point when creating guidelines for your own projects. Use when this capability is needed.

- Skill: `tomevault-io/project-guidelines-example-2` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/project-guidelines-example-2`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/project-guidelines-example-2/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/project-guidelines-example-2

---


# 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](https://zenith.chat) - 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

## Reference Documents

- [Architecture & File Structure](references/architecture.md) - Tech stack, service diagram, directory layout
- [Code Patterns](references/code-patterns.md) - API response format, frontend API calls, Claude AI integration, custom hooks
- [Testing & Deployment](references/testing-deployment.md) - pytest, React Testing Library, deployment commands, environment variables

## Critical Rules

1. **No emojis** in code, comments, or documentation
2. **Immutability** - never mutate objects or arrays
3. **TDD** - write tests before implementation
4. **80% coverage** minimum
5. **Many small files** - 200-400 lines typical, 800 max
6. **No console.log** in production code
7. **Proper error handling** with try/catch
8. **Input validation** with Pydantic/Zod

## Related Skills

- `coding-standards` - General coding best practices
- `backend-patterns` - API and database patterns
- `frontend-patterns` - React and Next.js patterns
- `tdd-workflow` - Test-driven development methodology

---
> Source: [cloudnative-co/claude-code-starter-kit](https://github.com/cloudnative-co/claude-code-starter-kit) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-07-06 -->

