Skip to content

Commit ef709c9

Browse files
tylerpinaclaude
andcommitted
docs: address Bito review comments
Fix grammar typo in ADR 0006 (+ → and), correct logSensitiveData default in AGENTS.md (false → true, matching CDAClient.java line 583), and fix integration test CI claim in CONTRIBUTING.md. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent e251e8f commit ef709c9

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Read this file first. It tells you where to find context in this repo.
2626
- **Android: never depend on `okhttp-jvm` directly when using `okhttp-android`** — exclude `okhttp-jvm` from this library to avoid duplicate-class errors on Android (see README and ADR 0002).
2727
- **`TlsSocketFactory` only activates below Android API 20** — do not remove or gate it differently; it protects older devices.
2828
- **`TransformQuery.observeAndTransform()` auto-injects a `select` filter** — if the annotation scanner has a bug, fields are silently dropped, not thrown as errors. Always validate field mapping in tests.
29-
- **`logSensitiveData` defaults to `false`** — never flip this to `true` in production builds; auth tokens would be logged.
29+
- **`logSensitiveData` defaults to `true`** — always set this to `false` in production builds to avoid logging auth tokens.
3030
- **Release requires GPG signing** — the Maven Central publication flow requires the Contentful GPG key imported locally. Do not attempt to release without it.
3131
- **`master` is the trunk** — there is no `main` branch. All CI and release flows target `master`.
3232

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ devcontainer exec --workspace-folder . bash
4444
./mvnw -B test
4545
```
4646

47-
- **Integration tests** connect to live Contentful spaces using hardcoded read-only credentials (space IDs and tokens are baked into the test classes under `src/test/java/…/cda/integration/`). No environment variables are required. Integration tests are not run in CI — run them locally when you need to verify against the live API.
47+
- **Integration tests** connect to live Contentful spaces using hardcoded read-only credentials (space IDs and tokens are baked into the test classes under `src/test/java/…/cda/integration/`). No environment variables are required. Integration tests are included in the `./mvnw -B test` run and therefore execute in CI.
4848

4949
## Commit Convention
5050

‎docs/ADRs/0006-transform-query-annotation-mapping.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Accepted
88

99
## Context
1010

11-
Consumers often want to map CDA Entry responses to their own domain model classes rather than working with the generic `CDAEntry` + field maps. Without a mapping layer, consumers write repetitive boilerplate to extract typed fields from `CDAEntry.getField()`. A code generation approach (similar to ORM annotation processors) was considered but adds build complexity.
11+
Consumers often want to map CDA Entry responses to their own domain model classes rather than working with the generic `CDAEntry` and field maps. Without a mapping layer, consumers write repetitive boilerplate to extract typed fields from `CDAEntry.getField()`. A code generation approach (similar to ORM annotation processors) was considered but adds build complexity.
1212

1313
Source: Java SDK Contractor Handover Template (Glean, 2026-03).
1414

0 commit comments

Comments
 (0)