chore: moving towards agentic development
This commit is contained in:
34
docs/CONVENTIONS.md
Normal file
34
docs/CONVENTIONS.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Conventions
|
||||
|
||||
## Backend
|
||||
|
||||
- Use FastEndpoints handlers for API work.
|
||||
- Keep request/response records near the handler unless an existing module pattern says otherwise.
|
||||
- Add FluentValidation validators for non-trivial input.
|
||||
- Use explicit routes and tags.
|
||||
- Preserve workspace scoping for workspace-owned data.
|
||||
- Keep schema changes in the owning data area and update migrations intentionally.
|
||||
|
||||
## Frontend
|
||||
|
||||
- Use `frontend/src/config.js` for runtime configuration.
|
||||
- Use the shared Axios API client in `frontend/src/plugins/api.js` for current JavaScript flows.
|
||||
- Preserve auth refresh behavior in `authStore` and the API plugin.
|
||||
- Route-level authenticated app screens live under `/app/*`.
|
||||
- New isolated feature slices should prefer `frontend/src/features/<feature>/`.
|
||||
- Do not move existing views/stores into feature folders unless a task owns that migration.
|
||||
|
||||
## Docs
|
||||
|
||||
- Current feature behavior belongs in `docs/FEATURES/`.
|
||||
- Implementation work belongs in `docs/TASKS/<feature>/`.
|
||||
- Reusable prompts belong in `docs/PROMPTS/`.
|
||||
- Durable decisions belong in `docs/DECISIONS/`.
|
||||
- Archived material belongs in `docs/archive/`.
|
||||
|
||||
## Validation
|
||||
|
||||
- Backend changes: `dotnet build backend/Socialize.slnx`
|
||||
- Backend behavior changes: `dotnet test backend/Socialize.slnx`
|
||||
- Frontend changes: `cd frontend && npm run build`
|
||||
- Backend contract changes: `./scripts/update-openapi.sh`
|
||||
Reference in New Issue
Block a user