Skip to content

chore: add agent skills pinning repository development conventions#2912

Merged
Lancetnik merged 11 commits into
mainfrom
feat/agent-skills
Jun 9, 2026
Merged

chore: add agent skills pinning repository development conventions#2912
Lancetnik merged 11 commits into
mainfrom
feat/agent-skills

Conversation

@Lancetnik

Copy link
Copy Markdown
Member

Description

Adds four agent skills under .agents/skills/ (with symlinks in .claude/skills/ for Claude Code auto-discovery) that pin this repository's development conventions for AI coding agents:

  • code-architecture — public vs _internal split, broker package anatomy (kafka as canonical reference), feature mirroring across brokers, strict-mypy typing rules, config and public-API conventions
  • testing-patterns — base testcase inheritance (tests/brokers/base/), strict pytest markers, fixtures, in-memory TestBroker vs connected real-broker testing, how to run the suite
  • documentation-writingdocs/docs/en page layout, docs_src snippet embedding via mdx_include, snippet tests under tests/docs/, link/tab conventions, idiomatic FastStream example-code rules
  • dev-workflow — uv + just toolchain, docker broker management, test matrix, lint/static-analysis gauntlet, CI expectations

The skills are hybrid-style: hard rules + small inline examples + pointers to canonical files as the source of truth. Every factual claim (just recipes, marker expressions, mypy/ruff config, CI selections, package layouts) was verified against the current codebase. Symlinks are relative so they work from any checkout path; non-Claude tools can read the canonical .agents/skills/ copies directly.

This replaces the conventions previously carried in the removed .cursor/rules/faststream.mdc — its FastStream-usage rules are preserved inside the documentation-writing skill.

Type of change

  • Documentation (typos, code examples, or any documentation updates)

Checklist

  • I have conducted a self-review of my own code
  • My changes do not generate any new warnings (markdown + symlinks only; no Python code touched — lint/test/static-analysis checklist items are not applicable to this diff)

🤖 Generated with Claude Code

- dev-workflow: just linter runs ruff format which rewrites files;
  only the ruff check step is non-modifying
- code-architecture: add asgi/, opentelemetry/, prometheus/ to the
  cross-broker public packages list
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 9, 2026
@Lancetnik Lancetnik force-pushed the feat/agent-skills branch from c2fe010 to 1a619c4 Compare June 9, 2026 20:00
@Lancetnik Lancetnik added this pull request to the merge queue Jun 9, 2026
Merged via the queue into main with commit 827ea37 Jun 9, 2026
45 of 55 checks passed
@Lancetnik Lancetnik deleted the feat/agent-skills branch June 9, 2026 22:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants