Skip to content

AGENTS.md#91

Merged
stephen-derosa merged 7 commits intolivekit:mainfrom
stephen-derosa:sderosa/clt-2485-AGENTS.MD
Apr 21, 2026
Merged

AGENTS.md#91
stephen-derosa merged 7 commits intolivekit:mainfrom
stephen-derosa:sderosa/clt-2485-AGENTS.MD

Conversation

@stephen-derosa
Copy link
Copy Markdown
Contributor

Overview

An AGENTS.MD file for guiding cursor on development inside the project

Key points

  • Architecture
  • Build preferences
  • Testing
  • Formatting
  • comments on readability vs performance

Any other points?

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds an AGENTS.md guidance document intended for development agents working in the LiveKit C++ Client SDK repo, summarizing architecture, build flow, coding conventions, dependencies, testing, and pitfalls.

Changes:

  • Introduces AGENTS.md with project architecture notes and key internal/public types.
  • Documents recommended build and packaging commands, plus dependency/tooling expectations.
  • Captures coding conventions (logging, public API boundaries, error handling) and testing guidance.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
@stephen-derosa stephen-derosa force-pushed the sderosa/clt-2485-AGENTS.MD branch 2 times, most recently from bc80b84 to cf6bc19 Compare April 13, 2026 18:00
@stephen-derosa stephen-derosa force-pushed the sderosa/clt-2485-AGENTS.MD branch from cf6bc19 to 348ce39 Compare April 13, 2026 18:04
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
Comment thread AGENTS.md
@xianshijing-lk
Copy link
Copy Markdown
Collaborator

xianshijing-lk commented Apr 13, 2026

Do you find it useful to have the agents.md ?

like, if claude / codex / cursor generate better results with this agents.md ? or it does not have much impact?

Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
@stephen-derosa
Copy link
Copy Markdown
Contributor Author

Do you find it useful to have the agents.md ?

like, if claude / codex / cursor generate better results with this agents.md ? or it does not have much impact?

@xianshijing-lk yeah i have found this file to be useful. Its hard to quantify but i have noticed the rules taking place such as copyright and logging preferences.

Copy link
Copy Markdown
Collaborator

@xianshijing-lk xianshijing-lk left a comment

Choose a reason for hiding this comment

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

lgtm, thanks Stephen

@stephen-derosa stephen-derosa merged commit 6c766ab into livekit:main Apr 21, 2026
1 check passed
@stephen-derosa stephen-derosa deleted the sderosa/clt-2485-AGENTS.MD branch April 21, 2026 21:45
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.

4 participants