project-guidelines-example

Provide project-specific development guidelines covering architecture, testing, and deployment workflows.

1|Updated Mar 10, 2026
One-click install
npx skills add https://github.com/aleonsa/claude-config --skill project-guidelines-example-aleonsa
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-guidelines-example
Source: https://github.com/aleonsa/claude-config/tree/main/claude/skills/project-guidelines-example
Command: npx skills add https://github.com/aleonsa/claude-config --skill project-guidelines-example-aleonsa

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive, project-specific set of guidelines and best practices for developers working on a particular application, ensuring consistency and quality.

Core Features & Use Cases

  • Architecture Overview: Details the tech stack, services, and deployment strategy.
  • File Structure: Outlines the expected organization of project files and directories.
  • Code Patterns: Provides examples of common API response formats, frontend calls, AI integrations, and custom hooks.
  • Testing Requirements: Specifies backend (pytest) and frontend (React Testing Library) testing methodologies.
  • Deployment Workflow: Includes pre-deployment checklists and commands.
  • Critical Rules: Lists non-negotiable coding standards and principles.
  • Use Case: When onboarding a new developer to the Zenith project, this skill serves as the definitive guide to its architecture, coding standards, and deployment process.

Quick Start

Use the project-guidelines-example skill to understand the testing requirements for the backend.

Frequently Asked Questions about project-guidelines-example

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I establish project-specific development standards for a new application?

Project-specific development standards are established by defining architecture, file structure, code patterns, testing requirements, and deployment workflows. This skill enforces critical rules such as immutability, TDD, and input validation to ensure consistency and quality across a production application.

What are the critical coding rules for maintaining development standards in a production app?

Critical coding rules for development standards include enforcing immutability, Test-Driven Development (TDD), and input validation. These non-negotiable principles ensure code quality and consistency across the application's architecture and deployment workflow.

How do I set up testing requirements using pytest and React Testing Library?

Testing requirements are set up by specifying pytest for backend testing and React Testing Library for frontend testing. These methodologies enforce TDD practices and ensure robust validation before deployment.

Does this project guidelines approach work for onboarding developers to a specific tech stack?

Yes, this project guidelines approach works for onboarding developers by providing a definitive guide to the tech stack, architecture, coding standards, and deployment process. It details common API response formats, frontend calls, and AI integrations.

What's the best way to document deployment workflows and pre-deployment checklists?

The best way to document deployment workflows is by including pre-deployment checklists and specific deployment commands within the project guidelines. This ensures all architecture and file structure standards are verified before releasing the production application.

When do I need to enforce immutability and input validation in my code patterns?

You need to enforce immutability and input validation in your code patterns whenever writing production application logic. These are non-negotiable critical rules applied to API response formats, frontend calls, and AI integrations to prevent edge case failures.