Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.87 KB

AGENTS.md

File metadata and controls

50 lines (31 loc) · 1.87 KB

AGENTS.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

modern-di-faststream is a FastStream adapter over modern-di; CONTEXT.md opens with what it does and owns the vocabulary. Read it before naming a concept in code, a test name, or an issue title. It is one of that project's integrations, each of which lives in a separate repository and ships as a separate PyPI package.

Commands

just (task runner) and uv (package manager). The justfile is the source of truth: just --list, or read it.

Architecture

All implementation is modern_di_faststream/main.py, short enough to read whole. Read it.

Testing patterns

The suite runs against a real broker double, not mocks: TestNatsBroker + TestApp from FastStream, with tests/dependencies.py as the Group every test resolves from. A test that needs DI wired takes the app fixture from tests/conftest.py.

Workflow

Every link in README.md must be absolute: https://github.com/modern-python/<repo>/blob/main/<path>, or .../tree/main/<path> for a directory. Never a relative path: README.md is also the PyPI long description, and PyPI does not rewrite relative links, so a relative one 404s on the package page.

Before pushing a raised dependency floor, run the floors steps from _checks.yml locally. If resolution fails, raise the direct floor it names.

Agent skills

Issue tracker

GitHub issues on modern-python/modern-di-faststream, via gh. See docs/agents/issue-tracker.md.

Triage labels

The five canonical roles, each label string equal to its name. See docs/agents/triage-labels.md.

Domain docs

Single-context: CONTEXT.md and docs/adr/ at the repo root. See docs/agents/domain.md.