chore(docs): require app logging in the definition of done #339

Merged
JMR-dev merged 10 commits from chore-claudemd-dod-logging into main 2026-07-05 05:54:55 +00:00
JMR-dev commented 2026-07-05 02:27:56 +00:00 (Migrated from github.com)

Summary

  • Adds a new requirement to CLAUDE.md's Definition of Done: app source-code changes must add appropriate, PII-free logging at key points (lifecycle transitions, error/fallback paths, significant state changes) so behaviour is diagnosable from a user's debug report.
  • Specifies logging through the AppLog facade (org.libremail.reporting.AppLog), which mirrors to Logcat and the in-memory RingLogBuffer feeding a DebugReport — not raw android.util.Log.
  • Calls out the PII-free mandate (no emails/hosts/message content/credentials; use accountLogRef(account.id) for account references; throwables auto-scrubbed) and scopes the rule to app source changes only (test/config/doc-only changes are exempt).

Docs-only change; no code touched.

Test plan

  • Re-read the edited ## Definition of done section for coherence with surrounding prose/style — no build needed for a doc-only change.

🤖 Generated with Claude Code

## Summary - Adds a new requirement to `CLAUDE.md`'s Definition of Done: app source-code changes must add appropriate, PII-free logging at key points (lifecycle transitions, error/fallback paths, significant state changes) so behaviour is diagnosable from a user's debug report. - Specifies logging through the `AppLog` facade (`org.libremail.reporting.AppLog`), which mirrors to Logcat and the in-memory `RingLogBuffer` feeding a `DebugReport` — not raw `android.util.Log`. - Calls out the PII-free mandate (no emails/hosts/message content/credentials; use `accountLogRef(account.id)` for account references; throwables auto-scrubbed) and scopes the rule to app source changes only (test/config/doc-only changes are exempt). Docs-only change; no code touched. ## Test plan - [x] Re-read the edited `## Definition of done` section for coherence with surrounding prose/style — no build needed for a doc-only change. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
Sign in to join this conversation.