docs(common): add conventional commits guideline and environment config to AGENTS.md
- Add dedicated Conventional Commits section with types and examples - Document environment.ts as API URL configuration source - Add to important files table
This commit is contained in:
parent
d87f6fe95b
commit
56f8636f90
31
AGENTS.md
31
AGENTS.md
@ -28,6 +28,7 @@ Energiegemeinschaftsverwaltung, Mitgliedschaften und Tarife.
|
|||||||
- API-Client wird aus OpenAPI-Spec generiert (`npm run generate-api`)
|
- API-Client wird aus OpenAPI-Spec generiert (`npm run generate-api`)
|
||||||
- Test-Framework: Vitest
|
- Test-Framework: Vitest
|
||||||
- Code-Style: Prettier (100 Zeichen, Single Quotes, Angular HTML Parser)
|
- Code-Style: Prettier (100 Zeichen, Single Quotes, Angular HTML Parser)
|
||||||
|
- API-URL über `src/environments/environment.ts` konfigurierbar (nicht hardcodiert)
|
||||||
|
|
||||||
## Entwicklung starten
|
## Entwicklung starten
|
||||||
|
|
||||||
@ -117,6 +118,7 @@ NEW → WAITING_FOR_CONSENT → CONSENT_GRANTED → ACTIVE
|
|||||||
| `eeg_backend/.../iam/config/AdminDataInitializer.java` | Initialer Admin-User (dev) |
|
| `eeg_backend/.../iam/config/AdminDataInitializer.java` | Initialer Admin-User (dev) |
|
||||||
| `eeg_backend/.../OpenApiGeneratorTest.java` | Generiert OpenAPI-Spec |
|
| `eeg_backend/.../OpenApiGeneratorTest.java` | Generiert OpenAPI-Spec |
|
||||||
| `eeg_frontend/openapi.yaml` | API-Vertrag für Frontend-Generierung |
|
| `eeg_frontend/openapi.yaml` | API-Vertrag für Frontend-Generierung |
|
||||||
|
| `eeg_frontend/src/environments/environment.ts` | API-URL Konfiguration |
|
||||||
| `eeg_frontend/src/app/app.routes.ts` | Frontend-Routing (alle Pages) |
|
| `eeg_frontend/src/app/app.routes.ts` | Frontend-Routing (alle Pages) |
|
||||||
|
|
||||||
## Regeln
|
## Regeln
|
||||||
@ -125,3 +127,32 @@ NEW → WAITING_FOR_CONSENT → CONSENT_GRANTED → ACTIVE
|
|||||||
- Explizite `isEnabled()`-Überschreibung in `User.java` nötig (Lombok/Spring Security Konflikt)
|
- Explizite `isEnabled()`-Überschreibung in `User.java` nötig (Lombok/Spring Security Konflikt)
|
||||||
- Conventional Commits: `<type>(<scope>): <description>` (feat/fix/docs/style/refactor/test/chore)
|
- Conventional Commits: `<type>(<scope>): <description>` (feat/fix/docs/style/refactor/test/chore)
|
||||||
- Scopes: `iam`, `community`, `mako`, `tariff`, `dashboard`, `common`, `frontend`
|
- Scopes: `iam`, `community`, `mako`, `tariff`, `dashboard`, `common`, `frontend`
|
||||||
|
|
||||||
|
## Conventional Commits
|
||||||
|
|
||||||
|
Ab jetzt werden [Conventional Commits](https://www.conventionalcommits.org/) verwendet:
|
||||||
|
|
||||||
|
```
|
||||||
|
<type>(<scope>): <description>
|
||||||
|
|
||||||
|
[optional body]
|
||||||
|
|
||||||
|
[optional footer]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Typen
|
||||||
|
- `feat`: Neue Funktion
|
||||||
|
- `fix`: Bugfix
|
||||||
|
- `docs`: Dokumentation
|
||||||
|
- `style`: Formatierung (keine Code-Änderung)
|
||||||
|
- `refactor`: Code-Refactoring ohne Funktionsänderung
|
||||||
|
- `test`: Tests hinzugefügt/ergänzt
|
||||||
|
- `chore`: Build-Prozess, Abhängigkeiten, Konfiguration
|
||||||
|
|
||||||
|
### Beispiele
|
||||||
|
```
|
||||||
|
feat(iam): add user profile management
|
||||||
|
fix(mako): handle consent rejected event correctly
|
||||||
|
docs: update AGENTS.md with conventional commits
|
||||||
|
test(iam): add UserService unit tests
|
||||||
|
```
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user