Skip to content

Improve copilot code review instructions, Fixes AB#3462756 #2849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shahzaibj merged 7 commits into from
Jan 8, 2026
Merged

Improve copilot code review instructions, Fixes AB#3462756 #2849

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0aa346f
Improve copilot code review instructions
shahzaibj Dec 30, 2025
25cc49a
Address copilot feedback
shahzaibj Dec 31, 2025
1da5288
Merge branch 'dev' into shahzaibj/3462756
shahzaibj Dec 31, 2025
204ed09
Merge branch 'dev' into shahzaibj/3462756
shahzaibj Jan 5, 2026
986cea5
Merge branch 'dev' into shahzaibj/3462756
shahzaibj Jan 7, 2026
9654535
Merge branch 'dev' into shahzaibj/3462756
shahzaibj Jan 8, 2026
98f6cf4
Merge branch 'dev' into shahzaibj/3462756
shahzaibj Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Common provides cross-repository primitives:
- OAuth2/OIDC protocol request/response handling.
- Token cache, serialization, normalization (authority, environment, FOCI).
- Cryptography utilities (KeyStore, key wrapping, hashing, JWE/JWS support).
- Telemetry enums (SpanName, AttributeName, DataClassification) and instrumentation helpers.
- Telemetry enums (SpanName, AttributeName) and instrumentation helpers.
- IPC contracts & shared data models.
- Cloud instance & regional authority discovery and validation.
- Error taxonomy & mapping.
Expand Down Expand Up @@ -87,9 +87,7 @@ Common provides cross-repository primitives:
- No plaintext private keys in SharedPreferences; KeyStore usage required.
- Key rotation atomic: old key decommission only after new key validated.

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

Expand Down Expand Up @@ -366,11 +364,6 @@ Don't create spans for:
- For booleans use primitive boolean, not string "true"/"false".
- For counts/sizes use numeric attributes, not stringified numbers.
- For timestamps where a dedicated DateTime attribute is defined (marked `isDateTime`), ensure value units match expected convention (typically epoch millis).
- For classification:
- OrganizationIdentifiableInformation: tenant- / org-level identifiers.
- EndUserPseudonymousIdentifiers: hashed or pseudonymous user correlation IDs (never raw secrets).
- SystemMetadata: runtime/system context safe for broader aggregation.
- EndUserIdentifiableInformation: only if absolutely necessary and privacy-compliant (e.g., hashed user IDs, not raw PII).

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