From ab2dc8103e6d5c4687ffeb40f52deefb8f5763c4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=82=8D=E3=82=80=E3=81=AD=E3=81=93?= <66072112+r-ca@users.noreply.github.com> Date: Fri, 8 Dec 2023 11:27:01 +0900 Subject: [PATCH] WIP Update README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index ea8ca76d..13224cfe 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ # Lacerta WIP +## モジュール設計 +![Untitled Diagram drawio(2)](https://github.com/lacerta-doc/Lacerta/assets/66072112/47006ffd-0fd3-4eec-8a28-fb9629b990bf) + +## コーディング規則/推奨(WIP) +### 規則 +- `// TODO`コメントには任意のsuffixを付ける + - 全員が同じ`// TODO:`を使っていると検索がむずかしくなるため + - (例: `// TODO-rca:`) +### 推奨 +- マジックナンバーは控える(必要な場合もあるので) +