]> Piment Noir Git Repositories - e-mobility-charging-stations-simulator.git/commitdiff
docs: streamline copilot instructions (#2053)
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Wed, 29 Jul 2026 17:18:23 +0000 (19:18 +0200)
committerGitHub <noreply@github.com>
Wed, 29 Jul 2026 17:18:23 +0000 (19:18 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
.github/copilot-instructions.md

index 07cb9620d23ff2a68e03a39abca0a1302bb6107b..f027546a6047754fa597a44245d4e80549f35965 100644 (file)
@@ -117,70 +117,11 @@ Documentation serves as an operational specification, not narrative prose.
 
 ## Quality gates
 
-Each sub-project has its own quality gates (format, typecheck, lint, build, test). See sub-project READMEs for exact commands. Run gates for every sub-project affected by your changes.
+Each sub-project has its own quality gates (format, lint, typecheck, build, test). See sub-project READMEs for exact commands. Run gates for every sub-project affected by your changes.
 
 - Logs use appropriate levels (error, warn, info, debug).
 - Pull request title and commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) format.
 
-## Examples
-
-### Naming coherence
-
-**Good** (consistent style, clear semantics):
-
-```typescript
-const thresholdValue = 0.06
-const processingMode = 'piecewise'
-type ChargingStationStatus = 'Available' | 'Preparing' | 'Charging'
-```
-
-**Bad** (mixed styles, ambiguous):
-
-```typescript
-const threshold_value = 0.06    // inconsistent case style
-const thresholdAim = 0.06       // synonym creates ambiguity
-type charging_station_status    // wrong casing for type
-```
-
-### Promise-based request/response pattern
-
-**Good** (proper async flow):
-
-```typescript
-protected handleProtocolRequest(
-  uuid: string,
-  procedureName: ProcedureName,
-  payload: RequestPayload
-): Promise<ResponsePayload> {
-  return new Promise<ResponsePayload>((resolve, reject) => {
-    this.pendingRequests.set(uuid, { reject, resolve })
-    this.sendBroadcastChannelRequest(uuid, procedureName, payload)
-  })
-}
-```
-
-**Bad** (returns void, no Promise):
-
-```typescript
-protected handleProtocolRequest(
-  uuid: string,
-  procedureName: ProcedureName,
-  payload: RequestPayload
-): void {
-  this.sendBroadcastChannelRequest(uuid, procedureName, payload)
-  // Response never reaches caller!
-}
-```
-
-### Statistical reporting
-
-```markdown
-| Metric      | Value | Interpretation        |
-| ----------- | ----- | --------------------- |
-| KL(A‖B)     | 0.023 | < 0.1: low divergence |
-| Effect size | 0.12  | small to medium       |
-```
-
 ---
 
 By following these instructions, coding agents should propose changes that are consistent and maintainable across languages.