Skip to content

Commit 0aa346f

Browse files
committed
Improve copilot code review instructions
1 parent 7ea5c92 commit 0aa346f

1 file changed

Lines changed: 3 additions & 4 deletions

File tree

.github/copilot-instructions.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Common provides cross-repository primitives:
2525
- OAuth2/OIDC protocol request/response handling.
2626
- Token cache, serialization, normalization (authority, environment, FOCI).
2727
- Cryptography utilities (KeyStore, key wrapping, hashing, JWE/JWS support).
28-
- Telemetry enums (SpanName, AttributeName, DataClassification) and instrumentation helpers.
28+
- Telemetry enums (SpanName, AttributeName) and instrumentation helpers.
2929
- IPC contracts & shared data models.
3030
- Cloud instance & regional authority discovery and validation.
3131
- Error taxonomy & mapping.
@@ -87,9 +87,8 @@ Common provides cross-repository primitives:
8787
- No plaintext private keys in SharedPreferences; KeyStore usage required.
8888
- Key rotation atomic: old key decommission only after new key validated.
8989

90-
### 1.9 Telemetry Enums & DataClassification
90+
### 1.9 Telemetry Enums
9191
- AttributeName constants carry classification; new requires doc + rationale.
92-
- Classification categories: SystemMetadata, OrganizationIdentifiableInformation, EndUserPseudonymousIdentifiers (never raw PII).
9392
- Adding attribute: uniqueness, bounded cardinality, doc comment specifying value domain & units.
9493
- Reuse existing SpanName for similar semantics; avoid duplication.
9594

@@ -383,7 +382,7 @@ Before adding:
383382
Checklist:
384383
1. Does an existing `AttributeName` already cover this semantic? If yes, reuse.
385384
2. Is the value stable, low/controlled cardinality, and privacy-compliant?
386-
3. Determine correct `DataClassification` (e.g., `SystemMetadata`, `EndUserPseudonymousIdentifiers`).
385+
3. Each attribute added to `AttributeName` MUST also be defined in the `AttributeName` file in the broker repo for cross-repo consistency. (Leave a comment reminding to do so.)
387386
4. For times/durations: prefer separate numeric metrics (ms) or mark `isDateTime=true` when representing an instant.
388387
5. Add Javadoc describing purpose and (if applicable) expected value set.
389388
6. Update any downstream dashboards or processing rules if necessary.

0 commit comments

Comments
 (0)