From 833ff24645be9ba89db1db180be9f43a0f135afa Mon Sep 17 00:00:00 2001 From: barsa Date: Wed, 19 Nov 2025 18:25:03 +0900 Subject: [PATCH] Update README.md to include coding standards - Added a new section outlining the coding standards for the codebase, emphasizing the importance of types, validation, and separation of business logic from the frontend. - Included guidelines for reusing existing types and following established folder structures to enhance maintainability and consistency across the project. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 5bf29570..277f2408 100644 --- a/README.md +++ b/README.md @@ -511,6 +511,13 @@ rm -rf node_modules && pnpm install - Avoid 'V2' suffixes in service names - Verify API integration against official documentation +## Codebase Coding Standard + +1. Have types and validation in the shared domain layer. +2. Keep business logic out of the frontend; use services and APIs instead. +3. Reuse existing types and functions; extend them when additional behavior is needed. +4. Follow the established folder structures documented in `docs/STRUCTURE.md`. + ## Documentation 📚 **[Complete Documentation](docs/README.md)** - Full documentation index