https://github.com/yumin-chen/project-template
https://github.com/yumin-chen/project-template
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/yumin-chen/project-template
- Owner: yumin-chen
- Created: 2025-11-29T11:00:24.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-11-29T12:04:49.000Z (7 months ago)
- Last Synced: 2025-12-01T13:14:37.906Z (7 months ago)
- Language: Makefile
- Size: 5.86 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Template
This repository is a general-purpose project template.
## 1. Folder Structure (Non-Meta Repository)
```
/guidelines/ # Policies, guidelines, and governance rules
/modules/ # References to a repo (or their meta) repositories
/content/ # Centralised content (CAS), assets and resources
/docs/architecture/design/ # ADRs (Architecture Decision Records)
/docs/technical/specs/ # TSDs (Technical Specification Documents)
/ci/ # CI/CD pipelines, policies, templates
```
**Note:** The `/docs` directory is reserved for non-meta (i.e., project) repositories only.
## 2. Naming and Storage Conventions
| Type | Storage Location (Meta Repo) | File Name | Title In-File |
| ---- | ---------------------------- | ------------------ | ------------------ |
| ADR | `/architecture/design/` | `adr-000-title.md` | `ADR-000: Title` |
| GDR | `/guidelines/decisions/` | `gdr-000-title.md` | `GDR-000: Title` |
| TSD | `/technical/specs/` | `tsd-000-title.md` | `TSD-000: Title` |
## Separation of Concerns
- **GDRs**: Governance, policies, and organizational rules.
- **ADRs**: High-level, deterministic architectural decisions (e.g., DAG/CD rules).
- **TSDs**: Mutable, implementation-level technical specifications.