Skip to content

Add AGENTS.md - #986

Draft
sbooth with Copilot wants to merge 1 commit into
mainfrom
copilot/generate-agents-md-file
Draft

Add AGENTS.md#986
sbooth with Copilot wants to merge 1 commit into
mainfrom
copilot/generate-agents-md-file

Conversation

Copilot AI commented Aug 21, 2026

Copy link
Copy Markdown

Adds AGENTS.md to give AI coding agents (and new contributors) a concise orientation to the repository.

Contents

  • Structure — maps Sources/CSFBAudioEngine/ subdirectories to their roles (decoders, encoders, player, metadata, I/O, etc.)
  • Build & testswift build / swift test; notes macOS + Xcode requirement and binary XCFramework dependency resolution via SPM
  • Code style — clang-format (LLVM-based, 120-col, 4-space indent) for C/ObjC/C++; .editorconfig baseline; Swift style by convention
  • Language standards — C11, C++20
  • Design patterns — decoder/encoder protocol hierarchy (SFBAudioDecoding, SFBPCMDecoding, SFBDSDDecoding, SFBPCMEncoding), SFBInputSource/SFBOutputTarget abstraction, SFBAudioPlayer on AVAudioEngine
  • Adding decoders/encoders — where to place files, which protocol to implement, registration pattern, license compatibility check
  • LGPL note — libsndfile, mpg123, libtta-cpp, LAME, and Musepack encoder must remain dynamically linked

…coding conventions

Co-authored-by: sbooth <9965+sbooth@users.noreply.github.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.

2 participants