From 90f8df37b1b5312fd851360c4d33c5b0ea1cb7ba Mon Sep 17 00:00:00 2001 From: DatTT127 Date: Tue, 23 Jun 2026 12:53:46 +0700 Subject: [PATCH] Update README: clarify snake_case naming rule to allow hyphens in docker-compose files --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 393aba5..9ad7417 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ - For large datasets, documents, presentations, or binary assets, store them in an external storage system (e.g., Amazon S3, Google Cloud Storage, Azure Blob) and reference them via a URL/link in the appropriate markdown or documentation file. - Images that illustrate documentation or design (e.g., diagrams, screenshots) may be committed directly **if** they are small and aid understanding, but large image datasets must be stored externally and linked. - Keep the repository lightweight and IDE‑friendly to ensure fast cloning, searching, and navigation. -- Use **snake_case** naming for files and directories (lowercase letters, numbers, and underscores only). Avoid spaces, hyphens, and special characters. Uppercase is acceptable for constants (e.g., `CONFIG.json`) but prefer lowercase. +- Use **snake_case** naming for files and directories (lowercase letters, numbers, and underscores only). Avoid spaces and special characters. Hyphens are discouraged except for specific configuration files like `docker-compose.yaml` or `docker-compose.yml`. Uppercase is acceptable for constants (e.g., `CONFIG.json`) but prefer lowercase. ## Overview This repository contains the research, design, and implementation materials for the MSK Ultrasound Stack pilot project. It includes documentation, design artifacts, source code, and supporting files organized to facilitate collaborative development while maintaining clear separation between shared assets and individual developer secrets.