@@ -52,6 +52,45 @@ npm run web:dev
5252
5353If executed successfully, it will start at http://localhost:5173 , so please try accessing it from your browser.
5454
55+ ## Linting and Code Style
56+
57+ This project uses ** ESLint** and ** Prettier** to enforce code quality and consistent style.
58+
59+ ### ESLint Configuration
60+
61+ - ** Config files** : ESLint configurations are located in each package directory:
62+ - ` packages/web/.eslintrc.cjs ` (Frontend)
63+ - ` packages/cdk/.eslintrc.cjs ` (CDK/Infrastructure)
64+ - ` browser-extension/.eslintrc.json ` (Browser Extension)
65+ - ** Base rules** : We extend commonly used configs:
66+ - ` eslint:recommended `
67+ - ` plugin:@typescript-eslint/recommended `
68+ - ` plugin:react-hooks/recommended ` (for React code)
69+ - ` plugin:tailwindcss/recommended ` (for frontend)
70+ - ** Key rules enforced** :
71+ - Unused imports/variables
72+ - React Hooks rules (e.g., ` exhaustive-deps ` )
73+ - Japanese string detection (i18n compliance)
74+ - YAML formatting and key sorting
75+
76+ ### Running ESLint
77+
78+ Before committing, run:
79+
80+ ``` bash
81+ npm run lint
82+ ```
83+
84+ To automatically fix issues:
85+
86+ ``` bash
87+ npm run web:lint:fix # For frontend code
88+ ```
89+
90+ ### Pre-commit Hook
91+
92+ This repository uses [ Husky] ( https://typicode.github.io/husky ) for git hooks. Linting runs automatically on ` git commit ` via ` lint-staged ` .
93+
5594## When Submitting a Pull Request
5695
5796We welcome Pull Requests for bug fixes and feature improvements :tada :
@@ -72,6 +111,12 @@ If you want to ignore this error and create a Draft PR, add the `--no-verify` op
72111git commit -m " xxx" --no-verify
73112```
74113
114+ ### Review Standards
115+
116+ - Lint rules are used as ** review criteria** .
117+ - Please ensure your code passes linting before opening a PR to avoid unnecessary review cycles.
118+ - Consistent style improves readability and reduces back-and-forth in code review.
119+
75120Also, if there are changes to the CDK, check the snapshots with the following command and update them:
76121
77122``` bash
0 commit comments