Project Structure Guide

Language: English | 繁體中文

Version: 1.0.0 Last Updated: 2025-12-30 Applicability: Claude Code Skills

Purpose

This skill provides guidance on structuring projects according to language and framework conventions. It helps create consistent, maintainable directory layouts.

Trigger

Use this skill when:

• Creating a new project
• Reorganizing existing project structure
• Adding new modules or features
• Setting up build configuration
• Creating .gitignore files

Supported Languages

Common Structure Patterns

Standard Directories

project-root/
├── src/              # Source code
├── tests/            # Test files
├── docs/             # Documentation
├── tools/            # Build/deployment scripts
├── examples/         # Usage examples
├── config/           # Configuration files
└── .github/          # GitHub configuration

Build Output (Always gitignore)

dist/                 # Distribution output
build/                # Compiled artifacts
out/                  # Output directory
bin/                  # Binary executables

Language-Specific Guidelines

Node.js

project/
├── src/
│   ├── index.js
│   ├── routes/
│   ├── controllers/
│   ├── services/
│   └── models/
├── tests/
├── package.json
└── .gitignore

Python

project/
├── src/
│   └── package_name/
│       ├── __init__.py
│       └── main.py
├── tests/
├── pyproject.toml
└── .gitignore

Go

project/
├── cmd/
│   └── appname/
│       └── main.go
├── internal/
├── pkg/
├── go.mod
└── .gitignore

Quick Actions

Create Project Structure

When asked to create a project:

1. Ask for language/framework
2. Generate appropriate directory structure
3. Create essential config files
4. Generate .gitignore

Review Structure

When reviewing existing structure:

1. Check language conventions
2. Verify gitignore patterns
3. Suggest improvements
4. Identify misplaced files

Rules

1. Follow language conventions – Each language has established patterns
2. Separate concerns – Keep source, tests, docs separate
3. Gitignore build outputs – Never commit dist/, build/, out/
4. Consistent naming – Use language-appropriate casing
5. Config at root – Place config files at project root

Related Standards

• Core: Project Structure
• AI: Project Structure Options