Skip to content

docs: add AGENTS.md for structure, CI, and release - #286

Open
itsmeadi wants to merge 1 commit into
mainfrom
docs/agents-md
Open

itsmeadi wants to merge 1 commit into
mainfrom
docs/agents-md

Conversation

@itsmeadi

@itsmeadi itsmeadi commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Extend existing AGENTS.md with layout, Make targets, CI credential split (chat vs video), OpenAPI regen, and PyPI Trusted Publishing.

Test plan

  • Skim AGENTS.md against DEVELOPMENT.md and .github/workflows/release.yml
  • Confirm docs: title does not trigger a PyPI publish

Made with Cursor

Summary by CodeRabbit

  • Documentation
    • Expanded project documentation with setup instructions, repository structure, development commands, and testing guidance.
    • Added guidance for code generation, WebRTC and OpenAPI updates, CI workflows, releases, versioning, and pull-request conventions.
    • Documented testing requirements, credentials, generated-code boundaries, and recommended development workflows.

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Sep 10, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 67a4879f-5788-438b-bc85-1b45379a0205

📥 Commits

Reviewing files that changed from the base of the PR and between 242d57c and 4e8ea72.

📒 Files selected for processing (1)
  • AGENTS.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

AGENTS.md was expanded with contributor guidance for setup, repository layout, testing, code generation, CI, releases, versioning, and pull-request conventions.

Changes

Contributor Guidance

Layer / File(s) Summary
Contributor workflow documentation
AGENTS.md
Adds project setup, uv workflows, test categories, fixtures, OpenAPI and WebRTC regeneration, CI environments, release behavior, versioning, and pull-request title conventions.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to 4e8ea

The contributor guidance update does not introduce a current merge-blocking risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: adding AGENTS.md documentation for repository structure, CI, and release processes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/agents-md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mogita

mogita commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

No merge conflict, but the ## Release section is now stale: #287 replaced scripts/release/bump_version.py with release-please. bug: no longer releases, the dispatch inputs are one publish_tag instead of version_bump/use_current_version, and the suite now gates the tag rather than following it. ## CI needs a touch too, ci.yml is pull_request only now.

Source of truth is the Releases section of README.md. getstream-go#161 has the same section written against this flow if you want a template.

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.

2 participants