ValorVie

project-structure-guide

0
0
# Install this skill:
npx skills add ValorVie/custom-skills --skill "project-structure-guide"

Install specific skill from multi-skill repository

# Description

|

# SKILL.md


name: project-structure-guide
scope: universal
description: |
Guide for organizing project directories following language-specific best practices.
Use when: creating projects, reorganizing structure, adding modules, setting up builds.
Keywords: project, structure, directory, layout, gitignore, scaffold, ๅฐˆๆกˆ็ตๆง‹, ็›ฎ้Œ„.


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

Language Frameworks/Patterns
Node.js Express, NestJS, Next.js
Python Django, Flask, FastAPI
Java Spring Boot, Maven, Gradle
.NET ASP.NET Core, Console
Go Standard layout, cmd/pkg
Rust Binary, Library, Workspace
Kotlin Gradle, Android, Multiplatform
PHP Laravel, Symfony, PSR-4
Ruby Rails, Gem, Sinatra
Swift SPM, iOS App, Vapor

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

# Supported AI Coding Agents

This skill is compatible with the SKILL.md standard and works with all major AI coding agents:

Learn more about the SKILL.md standard and how to use these skills with your preferred AI coding agent.