Skip to content

Add CLAUDE.md and AGENTS.md for AI code assistants#198

Open
JAVGan wants to merge 1 commit into
mainfrom
agents
Open

Add CLAUDE.md and AGENTS.md for AI code assistants#198
JAVGan wants to merge 1 commit into
mainfrom
agents

Conversation

@JAVGan
Copy link
Copy Markdown
Collaborator

@JAVGan JAVGan commented May 8, 2026

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:

  • Add CLAUDE.md documenting project overview, development workflow, code standards, architecture, data models, schemas, testing, and dependency management for AI code assistants.
  • Add AGENTS.md as an alias reference to CLAUDE.md for tools expecting that filename.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 8, 2026

Reviewer's Guide

Adds 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 pattern

classDiagram
    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
Loading

Class diagram for attrs-based data models and JSON mixin

classDiagram
    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
Loading

File-Level Changes

Change Details Files
Introduce CLAUDE.md with repository-specific guidance for AI assistants on development workflow, standards, and architecture.
  • Document available tox environments for testing, linting, type checking, security scanning, docs, and dependency repinning.
  • Specify code style and tooling conventions including black, isort, flake8-docstrings, mypy settings, and supported Python versions.
  • Describe the BaseService[T] architecture and concrete cloud provider services for AWS and Azure.
  • Explain attrs-based data models, JSON (de)serialization via AttrsJSONDecodeMixin, and Azure schema management workflow.
  • Outline testing layout, mocking approach per provider, and dependency pinning/install strategy.
CLAUDE.md
Add AGENTS.md compatibility file for other AI tools.
  • Create AGENTS.md containing a single reference line to CLAUDE.md to act as a symlink-like guide entry point for tools expecting AGENTS.md.
AGENTS.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@JAVGan
Copy link
Copy Markdown
Collaborator Author

JAVGan commented May 8, 2026

@ashwgit @lslebodn PTAL

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

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.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
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>
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.

1 participant