autumn/jsowell-charger-web
1
0
Fork 0
mirror of https://codeup.aliyun.com/67c68d4e484ca2f0a13ac3c1/ydc/jsowell-charger-web.git synced 2026-06-13 03:39:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

update AGENTS.md

Browse Source
This commit is contained in:
jsowell
2026-06-02 09:14:30 +08:00
parent 6087bde3da
commit f419730747
2 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
AGENTS.md
View File

@@ -9,7 +9,7 @@ This repository contains a Java 8, multi-module Spring Boot backend plus a separ
- Entry point/service: `jsowell-admin/` (Spring Boot app).
- Shared/core: `jsowell-common/`, `jsowell-framework/`, `jsowell-system/`.
- Business/integrations: `jsowell-pile/`, `jsowell-netty/`, `jsowell-thirdparty/`, plus schedulers/generator/settlement modules.
- UI: `jsowell-ui/` (not part of the Maven build). Code is in `jsowell-ui/src/`, static assets in `jsowell-ui/public/`.
- UI: `jsowell-charge-ui/` (not part of the Maven build). Code is in `jsowell-charge-ui/src/`, static assets in `jsowell-charge-ui/public/`.
- Reference material: `doc/`, `docs/`; database scripts: `sql/`; helper batch scripts: `bin/`.
## Build, Test, and Development Commands
@@ -20,15 +20,15 @@ Backend (from repo root):
- `mvn test` (or `mvn -pl jsowell-admin test`): run backend tests.
- `mvn -pl jsowell-admin spring-boot:run -Dspring-boot.run.profiles=dev`: run the API locally.
UI (from `jsowell-ui/`):
- `npm run dev`: start dev server (uses `jsowell-ui/.env.*` modes).
UI (from `jsowell-charge-ui/`):
- `npm run dev`: start dev server (uses `jsowell-charge-ui/.env.*` modes).
- `npm run build:prd`: production build.
- `npm run lint`: ESLint on `src/`.
## Coding Style & Naming Conventions
- Java: follow existing conventions (4 spaces; `PascalCase` types; `camelCase` methods; `UPPER_SNAKE_CASE` constants). Keep changes scoped to one module when possible.
- UI: follow `jsowell-ui/.editorconfig` + `jsowell-ui/.eslintrc.js` (2 spaces, single quotes, no semicolons). Run `npm run lint` before PRs.
- UI: follow `jsowell-charge-ui/.editorconfig` + `jsowell-charge-ui/.eslintrc.js` (2 spaces, single quotes, no semicolons). Run `npm run lint` before PRs.
## Testing Guidelines
@@ -37,12 +37,12 @@ UI (from `jsowell-ui/`):
## Commit & Pull Request Guidelines
- Commit subjects commonly use short prefixes: `add ...`, `update ...`, `bugfix ...`. Keep them under ~72 chars; add module context when helpful (example: `jsowell-ui: update login flow`).
- Commit subjects commonly use short prefixes: `add ...`, `update ...`, `bugfix ...`. Keep them under ~72 chars; add module context when helpful (example: `jsowell-charge-ui: update login flow`).
- PRs should target `dev` unless agreed otherwise, include a clear description, and link the relevant issue/ticket.
- Include screenshots for UI changes and migration notes for DB/API changes (`sql/`, request/response examples).
## Security & Configuration Notes
- Environment config lives in `jsowell-admin/src/main/resources/application-*.yml` and `jsowell-ui/.env.*`.
- Environment config lives in `jsowell-admin/src/main/resources/application-*.yml` and `jsowell-charge-ui/.env.*`.
- Do not commit real secrets/keys; use placeholders and local overrides.
- See `CLAUDE.md` for deeper architecture and operational notes.