1.6 KiB
1.6 KiB
STARTFRESH.md
General Approach to New Projects
This document serves as a template and set of guiding principles for starting any new project, capturing the preferred methodology and structural rules.
1. Design & Architecture Philosophy
- Self-Sufficiency: Minimize external dependencies. Prefer tech stacks that offer local control and self-hosting capabilities (e.g., Python backend, PostgreSQL database).
- Tidy First, Fancy Later: Focus initially on clean structures, functional layouts, and standard technologies. Complex visuals and design polish should only be added once the foundational logic is proven.
2. Repository Rules
- Containment: No documents outside the folder. All project-related documents, notes, and files must reside strictly within the repository.
- Conciseness: Keep documentation brief, clear, and to the point.
- Single Source of Truth: Use single, dedicated documents for specific types of information to avoid fragmentation.
3. Required Foundational Documents
Every new project should initialize with the following document structure:
RULES.md: To declare foundational repository and workflow rules.ARCHITECTURE.md: To collect all architectural decisions, technology stack choices, and integration strategies.PLAN.md: To track ongoing steps, categorized by short, medium, and long-term goals. Must be revised after each PR.COMPONENTS.md: To track specific components used in the project. Rule: Only add components to this document once they have been actively included and utilized in the codebase.