project-guidelines-example

Generate project-specific guidelines covering architecture, file structure, code patterns, testing, and deployment.

1|Updated Feb 22, 2026
One-click install
npx skills add https://github.com/TakMczk/copilot-cli-ecc --skill project-guidelines-example-takmczk
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-guidelines-example
Source: https://github.com/TakMczk/copilot-cli-ecc/tree/main/.github/skills/project-guidelines-example
Command: npx skills add https://github.com/TakMczk/copilot-cli-ecc --skill project-guidelines-example-takmczk

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill provides a comprehensive template for project-specific guidelines, covering architecture, file structure, code patterns, testing, and deployment.

Core Features & Use Cases

  • Architecture Overview: Understand the tech stack and service interactions.
  • File Structure: Visualize the project's organization.
  • Code Patterns: Reference common API response formats, frontend calls, AI integration, and custom hooks.
  • Testing Requirements: Learn backend (pytest) and frontend (React Testing Library) testing strategies.
  • Deployment Workflow: Follow pre-deployment checklists and deployment commands.
  • Use Case: Onboarding a new developer to a project by providing them with a single source of truth for project conventions and workflows.

Quick Start

Reference the project-guidelines-example skill for details on the project's architecture and testing requirements.

Frequently Asked Questions about project-guidelines-example

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

FAQPage Schema
How do I create project guidelines for a Next.js and FastAPI application?

To create project guidelines for a Next.js and FastAPI application, use a development template covering architecture, file structure, code patterns, testing strategies, and deployment workflows to standardize documentation.

What testing strategies should I include in a full-stack project guidelines template?

A full-stack project guidelines template should include testing strategies utilizing pytest for backend validation and React Testing Library for frontend components to ensure code reliability and standardized testing requirements.

How do I document deployment workflows for Cloud Run in a project template?

To document deployment workflows for Cloud Run in a project template, define pre-deployment checklists and specific deployment commands to guide developers through the release process and maintain deployment consistency.

Can I use a project guidelines template for onboarding new developers to my tech stack?

Yes, you can use a project guidelines template for onboarding new developers to your tech stack. It provides a single source of truth for project conventions, architecture, and workflows, accelerating the onboarding process.

Does a standard project guidelines template cover AI integration with the Claude API?

Yes, a standard project guidelines template can cover AI integration with the Claude API by detailing common code patterns for API calls, ensuring developers follow best practices when implementing AI features.

What is the best way to structure code patterns for a PostgreSQL and React project?

The best way to structure code patterns for a PostgreSQL and React project is to document common API response formats, frontend data fetching calls, and custom hooks within a centralized project guidelines template.