ankhbayar/Assist_Design
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Update README.md to include coding standards

Browse Source 
- 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.
This commit is contained in:
barsa 2025-11-19 18:25:03 +09:00
parent 63acaef8cd
commit 833ff24645
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -511,6 +511,13 @@ rm -rf node_modules && pnpm install
- Avoid 'V2' suffixes in service names - Avoid 'V2' suffixes in service names
- Verify API integration against official documentation - 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 ## Documentation
📚 **[Complete Documentation](docs/README.md)** - Full documentation index 📚 **[Complete Documentation](docs/README.md)** - Full documentation index