37 lines
1.0 KiB
Markdown
37 lines
1.0 KiB
Markdown
# Templates
|
|
|
|
This directory is for reusable templates that do not belong to one specific service directory under `config/`.
|
|
|
|
## What Belongs Here
|
|
|
|
- Generic environment file examples.
|
|
- Reusable script templates.
|
|
- Documentation templates.
|
|
- Deployment manifest examples.
|
|
- Non-secret placeholder files.
|
|
|
|
## What Must Not Be Stored Here
|
|
|
|
- Live `.env` files.
|
|
- Passwords, tokens, private keys, or certificates.
|
|
- Generated credentials.
|
|
- Live service configuration.
|
|
- Build artefacts.
|
|
- Backups.
|
|
|
|
## Naming Conventions
|
|
|
|
- Use lower-case hyphenated names.
|
|
- Use `.template`, `.example`, or `.sample` suffixes where appropriate.
|
|
- Use obvious placeholder values such as `CHANGE_ME` or `${ENV_VAR_NAME}`.
|
|
|
|
## Expected Future Structure
|
|
|
|
Subdirectories may be introduced when templates grow beyond a small number of files.
|
|
|
|
Future structure is `TODO: Confirm during the relevant implementation phase.`
|
|
|
|
## Security Considerations
|
|
|
|
Templates are version-controlled and must be safe to publish to anyone with repository access. Never include a live credential, even temporarily.
|