Add initial CLAUDE.md for AI-assisted development#1342
Open
BryanFauble wants to merge 4 commits intodevelopfrom
Open
Add initial CLAUDE.md for AI-assisted development#1342BryanFauble wants to merge 4 commits intodevelopfrom
BryanFauble wants to merge 4 commits intodevelopfrom
Conversation
Captures non-obvious conventions (async-to-sync decorator, protocol classes, dataclass models with fill_from_dict, concrete Java types), architecture overview, verified commands, constraints, and testing patterns that Claude cannot infer from code alone. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Each file documents non-obvious patterns specific to that module: - models/: new model checklist, fill_from_dict pattern, _last_persistent_instance lifecycle, EnumCoercionMixin usage, standard field requirements - api/: function signature conventions, REST call patterns, pagination helpers, new service file checklist - core/: async_to_sync internals, retry strategies, credentials chain, upload/download resilience, concrete types registration - tests/: async-only test convention, unit test socket blocking, integration test cleanup with schedule_for_cleanup(), fixture scoping Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Rewrote 5 existing files with enhanced behavioral conventions (reusable utilities, conditional behavior, concurrency patterns). Added 11 new module-level files for full directory coverage: operations, models/mixins, models/services, models/protocols, core/upload, core/download, core/constants, core/credentials, extensions/curator, synapseutils, and docs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Remove flake8 from linting list (not a pre-commit hook, only test dep) - Add Docker info to Stack section - Add auth env vars and CI matrix details to Testing section - Fix docs deployment info: Read the Docs, not gh-deploy to GitHub Pages - Add docs build output dir and autorefs cross-linking syntax - Expand Windows socket isolation note in tests - Add conftest.py location guide for tests Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CLAUDE.md(95 lines) and 4 module-level CLAUDE.md files (170 lines total) capturing non-obvious conventions and patterns that AI assistants cannot infer from the code alonefill_from_dict(), concrete Java type mapping, mixin composition, layered architecture, testing conventionssynapseclient/models/: new model checklist, standard fields,_last_persistent_instancelifecycle,EnumCoercionMixin,fill_from_dict()pattern,@otel_trace_methodusagesynapseclient/api/: function signature conventions, REST call patterns, pagination helpers, new service file checklistsynapseclient/core/:async_to_syncinternals, retry strategies, credentials chain, upload/download resilience, concrete types registrationtests/: async-only test convention, socket blocking,schedule_for_cleanup(), fixture scopingbuild.yml,pytest.ini,.pre-commit-config.yaml)Test plan
🤖 Generated with Claude Code