mirror of
https://github.com/johndoe6345789/snippet-pastebin.git
synced 2026-04-24 13:34:55 +00:00
890 B
890 B
Project Documentation Conventions (Important)
Documentation Files: All new documentation or task files must be saved under the docs/ folder in this repository.For example:
- Tasks & TODOs: Save in
docs/{YYYY_MM_DD}/tasks/(e.g.,docs/t2025_08_08/asks/ReleaseTodo.mdfor a release checklist). - Requirements/Specs: Save in
docs/{YYYY_MM_DD}/specs/(e.g.,docs/2025_08_08/specs/AuthModuleRequirements.md). - Design Docs: Save in
docs/{YYYY_MM_DD}/design/(e.g.,docs/2025_08_08/design/ArchitectureOverview.md). - Code Files: Follow the project structure (place new code in the appropriate src/module folder as discussed).
- Tests: Put new test files under the
tests/directory, mirroring the code structure.
Important: When creating a new file, ensure the directory exists or create it. Never default to the root directory for these files.