Conversation
Reviewer's GuideAdds repository-local guidance for AI code assistants (CLAUDE.md) covering development workflows, code standards, and architecture, plus a minimal AGENTS.md shim pointing to the new guide. Class diagram for BaseService and cloud provider service patternclassDiagram
class PublishingMetadata {
}
class BaseService {
<<abstract>>
-T : PublishingMetadata
+publish(metadata T) None
}
class AWSProductService {
+publish(metadata AWSMetadata) None
-boto3_client
-tenacity_retry_policy
-manage_product_versions() None
-manage_delivery_options() None
-create_changeset() None
-poll_changeset() None
}
class AzureService {
+publish(metadata AzureMetadata) None
-partner_portal_session PartnerPortalSession
-deepdiff
-stage_draft() None
-stage_preview() None
-stage_live() None
-detect_minimal_changes() None
}
class PartnerPortalSession {
+send(request) Response
-https_retry
-sas_uri_handling
}
class AWSMetadata {
}
class AzureMetadata {
}
PublishingMetadata <|-- AWSMetadata
PublishingMetadata <|-- AzureMetadata
BaseService <|-- AWSProductService
BaseService <|-- AzureService
AzureService --> PartnerPortalSession
Class diagram for attrs-based data models and JSON mixinclassDiagram
class AttrsJSONDecodeMixin {
+from_json(data dict) AttrsJSONDecodeMixin
+to_json(hide_optional bool) dict
-field_aliases dict
-convert_nested_objects(data dict) dict
}
class AWSModel {
<<attrs>>
+version_title str
+other_fields
}
class AzureModel {
<<attrs>>
+resource_id str
+other_fields
}
class ResourceMapping {
+RESOURCE_MAPING dict
+get_resource_type(key str) type
}
AttrsJSONDecodeMixin <|-- AWSModel
AttrsJSONDecodeMixin <|-- AzureModel
ResourceMapping --> AzureModel
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Collaborator
Author
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- If AGENTS.md is meant to be a real symlink for tools, consider creating an actual filesystem symlink rather than a file containing the text
CLAUDE.md, since some tooling may treat this as a standalone markdown file instead of following it.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- If AGENTS.md is meant to be a real symlink for tools, consider creating an actual filesystem symlink rather than a file containing the text `CLAUDE.md`, since some tooling may treat this as a standalone markdown file instead of following it.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
CLAUDE.md provides guidance to Claude Code and other AI assistants when working in this repository. It documents development commands (tox environments, pytest usage), code standards (black, isort, flake8 settings), the BaseService[T] architecture pattern, data model serialization via attrs/AttrsJSONDecodeMixin, and the testing/dependency management workflow. AGENTS.md is a symlink to CLAUDE.md for tools that use that filename convention. Refers to SPSTRAT-736 Signed-off-by: Jonathan Gangi <jgangi@redhat.com> Co-Authored-By: Claude Opus 4.6 <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.
CLAUDE.md provides guidance to Claude Code and other AI assistants when working in this repository. It documents development commands (tox environments, pytest usage), code standards (black, isort, flake8 settings), the BaseService[T] architecture pattern, data model serialization via attrs/AttrsJSONDecodeMixin, and the testing/dependency management workflow.
AGENTS.md is a symlink to CLAUDE.md for tools that use that filename convention.
Refers to SPSTRAT-736
Summary by Sourcery
Document AI assistant usage and project conventions for this repository.
Documentation: