Skip to content

Update CLAUDE.md with info that came up during the handover prompt - #890

Open
lisajulia wants to merge 1 commit into
mainfrom
update-claude-md
Open

lisajulia wants to merge 1 commit into
mainfrom
update-claude-md

Conversation

@lisajulia

@lisajulia lisajulia commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor

Document Attachment Architecture and Design Decisions

Documentation

📚 Updated CLAUDE.md with additional architecture notes and handover context for the attachments feature, improving guidance for future maintainers and contributors.

Changes

  • CLAUDE.md: Added documentation for the two supported attachment models: composition-based attachments and inline attachment fields, including how inline attachments are detected and handled via FieldAccessor.
  • CLAUDE.md: Clarified the DefaultAttachmentsServiceHandler execution order and how storage plugins intercept attachment service events before the default DB handler.
  • CLAUDE.md: Documented storage plugin behavior for OSS/FS handlers, including context.setCompleted() and setIsInternalStored(false) handling.
  • CLAUDE.md: Added a new “Non-obvious Design Decisions” section covering:
    • Why create events are not outboxed while delete events are.
    • Rollback cleanup using CreationChangeSetListener.
    • Draft create/update handler ordering for readonly field preservation.
    • Lazy read proxy behavior and required query enrichment.
    • Thread-local draft activation context handling.
    • Draft patch behavior for deleted attachments and inline metadata persistence.
    • File size validation safeguards.
    • $value download detection via areKeysEmpty.
    • Malware rescan threshold rationale.
  • CLAUDE.md: Expanded key pattern descriptions for outbox usage and thread-local context bridging.
  • 🔄 Regenerate and Update Summary
PR Bot Information

Version: 1.31.48

  • LLM: gpt-5.5
  • Output Template: Default Template
  • File Content Strategy: Full file content
  • Correlation ID: 4e086f40-b65f-11f1-910b-91a0fdbb111b
  • Summary Prompt: Default Prompt
  • Event Trigger: pull_request.opened

@lisajulia
lisajulia requested a review from a team as a code owner September 22, 2026 08:26

@hyperspace-pr-bot hyperspace-pr-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn’t find any substantive issues in the documentation changes worth an inline review comment. The updates appear consistent with the referenced implementation details and improve handover context without changing executable behavior.

PR Bot Information

Version: 1.31.48

  • LLM: gpt-5.5
  • File Content Strategy: Full file content
  • Agent Instructions:
  • Correlation ID: 4e086f40-b65f-11f1-910b-91a0fdbb111b
  • Event Trigger: pull_request.opened

@Schmarvinius Schmarvinius left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm but i find it interesting to document the decision we haven't done. The rationale is sound imo but still

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants