tiennm99/composes
1
0 Fork 0
mirror of https://github.com/tiennm99/composes.git synced 2026-10-15 06:16:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: record compose.yml naming convention for new services

Browse Source 
New services take the current Compose spec filename. Existing
docker-compose.yml files stay as they are so unrelated changes do not
carry a rename.
This commit is contained in:
tiennm99 committed 2026-09-16 15:06:01 +07:00
1 parent 41fe522c0d
commit 2de7bb68ab
1 file changed
+7
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+7
View File
@@ -4,6 +4,13 @@ Personal docker compose collection. One directory per service, each holding
`compose.yml`, its own `README.md`, a committed `.env.example`, and a `compose.yml`, its own `README.md`, a committed `.env.example`, and a
gitignored `.env`. gitignored `.env`.
## File naming
New services use `compose.yml` — the current Compose spec name, and the
shorter one. Existing services that still use `docker-compose.yml` stay as
they are; do not rename them, not even while touching the file for something
else.
The root `README.md` is an index only — it covers the shared conventions and The root `README.md` is an index only — it covers the shared conventions and
links out to each service. Per-service detail (variables, ports, storage) links out to each service. Per-service detail (variables, ports, storage)
belongs in that service's README, not the root one. Adding a service means belongs in that service's README, not the root one. Adding a service means