forked from bchanot/claude
ameliore le init project et ajoute le readme updater
This commit is contained in:
bastien
+40
-166
@@ -1,200 +1,74 @@
|
||||
# Project CLAUDE.md
|
||||
# <PROJECT NAME> — CLAUDE.md
|
||||
|
||||
# =========================================================
|
||||
# This is a TEMPLATE file for repository-specific configuration
|
||||
# You can REMOVE sections that are not relevant to your project
|
||||
# and ADAPT examples to your stack (C, C++, Python, JS, etc.)
|
||||
# =========================================================
|
||||
# This file was generated by /init-project.
|
||||
# It is the single source of truth for Claude in this repository.
|
||||
# Global rules live in ~/.claude/CLAUDE.md — this file extends or
|
||||
# overrides them for this specific project.
|
||||
|
||||
---
|
||||
|
||||
# =========================================================
|
||||
# BUILD COMMANDS
|
||||
# =========================================================
|
||||
## Project overview
|
||||
|
||||
## Example: C / Makefile project
|
||||
# make -> build project
|
||||
# make clean -> remove object files
|
||||
# make fclean -> clean + remove binaries
|
||||
# make re -> rebuild everything
|
||||
<!-- FILL: 2–4 sentences. What does this project do and for whom. -->
|
||||
|
||||
## Example: Node.js
|
||||
# npm install
|
||||
# npm run build
|
||||
---
|
||||
|
||||
## Example: Python
|
||||
# pip install -r requirements.txt
|
||||
## Stack
|
||||
|
||||
## Example: Go
|
||||
# go build ./...
|
||||
<!-- FILL: language + version, framework, runtime, database, key services -->
|
||||
|
||||
## Example: Rust
|
||||
# cargo build
|
||||
---
|
||||
|
||||
## Define YOUR actual commands below:
|
||||
# - ...
|
||||
# - ...
|
||||
## Build commands
|
||||
|
||||
<!-- FILL: exact commands to build the project -->
|
||||
|
||||
# =========================================================
|
||||
# TEST COMMANDS
|
||||
# =========================================================
|
||||
---
|
||||
|
||||
## Example: C (custom tests)
|
||||
# ./tests/run_tests.sh
|
||||
## Test commands
|
||||
|
||||
## Example: Python
|
||||
# pytest
|
||||
<!-- FILL: exact commands to run tests -->
|
||||
|
||||
## Example: Node.js
|
||||
# npm test
|
||||
---
|
||||
|
||||
## Example: Go
|
||||
# go test ./...
|
||||
## Lint / format commands
|
||||
|
||||
## Example: Rust
|
||||
# cargo test
|
||||
<!-- FILL: exact commands, or N/A -->
|
||||
|
||||
## Define YOUR actual commands below:
|
||||
# - ...
|
||||
# - ...
|
||||
---
|
||||
|
||||
## Folder structure
|
||||
|
||||
# =========================================================
|
||||
# LINT / FORMAT / STATIC ANALYSIS
|
||||
# =========================================================
|
||||
<!-- FILL: actual tree of the project -->
|
||||
|
||||
## Example: C (42 / norminette)
|
||||
# norminette
|
||||
---
|
||||
|
||||
## Example: Python
|
||||
# flake8
|
||||
# black .
|
||||
## Architecture
|
||||
|
||||
## Example: JS/TS
|
||||
# npm run lint
|
||||
# prettier --write .
|
||||
<!-- FILL: module responsibilities, data flow, key design decisions -->
|
||||
|
||||
## Example: Go
|
||||
# go fmt ./...
|
||||
# golangci-lint run
|
||||
---
|
||||
|
||||
## Example: Rust
|
||||
# cargo fmt
|
||||
# cargo clippy
|
||||
## Project conventions
|
||||
|
||||
## Define YOUR actual commands below:
|
||||
# - ...
|
||||
# - ...
|
||||
<!-- FILL: naming style, file organization, patterns specific to this project -->
|
||||
|
||||
---
|
||||
|
||||
# =========================================================
|
||||
# PROJECT CONVENTIONS
|
||||
# =========================================================
|
||||
## Exceptions to global rules
|
||||
|
||||
# Describe coding conventions specific to THIS repository
|
||||
<!-- FILL: explicit overrides of ~/.claude/CLAUDE.md, or write "none — global rules apply" -->
|
||||
|
||||
## Example (C / 42-style)
|
||||
# - snake_case naming
|
||||
# - no for loops (if applicable)
|
||||
# - header files for declarations
|
||||
# - strict file organization
|
||||
---
|
||||
|
||||
## Example (Python)
|
||||
# - PEP8 compliance
|
||||
# - type hints required
|
||||
# - small functions preferred
|
||||
## Key dependencies
|
||||
|
||||
## Example (JS/TS)
|
||||
# - camelCase variables
|
||||
# - PascalCase classes
|
||||
# - functional components (React)
|
||||
<!-- FILL: library name — purpose, one line each -->
|
||||
|
||||
## Define YOUR conventions below:
|
||||
# - ...
|
||||
# - ...
|
||||
---
|
||||
|
||||
## Workflow expectations
|
||||
|
||||
# =========================================================
|
||||
# PROJECT ARCHITECTURE
|
||||
# =========================================================
|
||||
|
||||
# Describe how the project is structured
|
||||
|
||||
## Example:
|
||||
# src/
|
||||
# core/ -> business logic
|
||||
# utils/ -> helpers
|
||||
# api/ -> external interfaces
|
||||
# tests/
|
||||
# unit/
|
||||
# integration/
|
||||
|
||||
## Example (C project)
|
||||
# src/
|
||||
# include/
|
||||
# libft/
|
||||
# main.c
|
||||
|
||||
## Define YOUR architecture below:
|
||||
# - folders:
|
||||
# - responsibilities:
|
||||
# - data flow:
|
||||
|
||||
|
||||
# =========================================================
|
||||
# IMPORTANT RULES / CONSTRAINTS
|
||||
# =========================================================
|
||||
|
||||
# Example:
|
||||
# - no dynamic allocation in hot paths
|
||||
# - must be POSIX compliant
|
||||
# - no external dependencies allowed
|
||||
# - performance critical sections identified
|
||||
|
||||
## Define YOUR rules below:
|
||||
# - ...
|
||||
# - ...
|
||||
|
||||
|
||||
# =========================================================
|
||||
# EXCEPTIONS TO GLOBAL RULES
|
||||
# =========================================================
|
||||
|
||||
# This section overrides rules from ~/.claude/CLAUDE.md
|
||||
|
||||
## Example:
|
||||
# - functions >25 lines allowed in parser module
|
||||
# - global state allowed in logging system
|
||||
# - more than 5 parameters allowed in specific APIs
|
||||
|
||||
## Define YOUR exceptions below:
|
||||
# - ...
|
||||
# - ...
|
||||
|
||||
|
||||
# =========================================================
|
||||
# REVIEW / WORKFLOW EXPECTATIONS
|
||||
# =========================================================
|
||||
|
||||
# How Claude should behave in this repo
|
||||
|
||||
# Example:
|
||||
# - always run tests after modification
|
||||
# - never modify unrelated files
|
||||
# - prioritize minimal changes
|
||||
# - ask before large refactors
|
||||
|
||||
## Define YOUR expectations below:
|
||||
# - ...
|
||||
# - ...
|
||||
|
||||
|
||||
# =========================================================
|
||||
# NOTES
|
||||
# =========================================================
|
||||
|
||||
# - Remove unused sections
|
||||
# - Keep this file short and project-focused
|
||||
# - Global style rules live in ~/.claude/CLAUDE.md
|
||||
# - This file is for LOCAL overrides and context only
|
||||
|
||||
<!-- FILL: how Claude should behave in this repo:
|
||||
e.g. always run tests after modification, never modify unrelated files,
|
||||
ask before large refactors, etc. -->
|
||||
|
||||
Reference in New Issue
Block a user