Skip to content

Add AGENTS.md AI guardrails#152

Open
cjrolo wants to merge 4 commits intomainfrom
ai-enablement-forge
Open

Add AGENTS.md AI guardrails#152
cjrolo wants to merge 4 commits intomainfrom
ai-enablement-forge

Conversation

@cjrolo
Copy link
Collaborator

@cjrolo cjrolo commented Feb 23, 2026

Summary

  • Add AGENTS.md with repo-specific AI guardrails (format compatibility, performance expectations, key entry points).

Test plan

  • N/A (documentation-only change).

Made with Cursor

Copy link

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 guide intended to document repo-specific guardrails for AI-assisted changes, with emphasis on format compatibility and performance-sensitive code paths in the Rust workspace.

Changes:

  • Introduces a new AGENTS.md file describing key entry points and workflows (build/test/bench).
  • Documents on-disk format compatibility considerations (bincode, versioning guidance).
  • Adds performance guidance for working in hot paths and using Criterion benches.

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

cjrolo and others added 3 commits February 23, 2026 16:49
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Collaborator

@worryg0d worryg0d left a comment

Choose a reason for hiding this comment

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

This PR introduces rules for AI agents. I'm not really an AI expert, but it looks good from my point of view. It covers the format and its breaking changes, explicit frame versioning, and testing.

👍

Copy link

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.


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

Comment on lines +36 to +37
- **Changing the shape/order of `Encode`/`Decode` structs is format-breaking**, even if Rust still compiles.
- High-risk types include (non-exhaustive): `atsc::data::CompressedStream`, `atsc::frame::CompressorFrame`, `atsc::header::CompressorHeader`, and any compressor frame types in `atsc/src/compressor/*` (e.g. `FFT`, `FrequencyPoint`).
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

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

In the “High-risk types” list, atsc::data::CompressedStream is called out as an Encode/Decode struct, but in the code it’s not bincode-encoded (it has custom to_bytes/from_bytes and only the Vec<CompressorFrame> is bincode-encoded). Suggest tweaking the wording to distinguish: (1) bincode-encoded types where field order is format-breaking (e.g. CompressorFrame, compressor structs), and (2) format-critical types with custom serialization (CompressedStream, CompressorHeader).

Suggested change
- **Changing the shape/order of `Encode`/`Decode` structs is format-breaking**, even if Rust still compiles.
- High-risk types include (non-exhaustive): `atsc::data::CompressedStream`, `atsc::frame::CompressorFrame`, `atsc::header::CompressorHeader`, and any compressor frame types in `atsc/src/compressor/*` (e.g. `FFT`, `FrequencyPoint`).
- **Changing the shape/order of bincode `Encode`/`Decode` structs is format-breaking**, even if Rust still compiles.
- **Bincode-encoded, order-sensitive types** include (non-exhaustive): `atsc::frame::CompressorFrame` and compressor frame structs in `atsc/src/compressor/*` (e.g. `FFT`, `FrequencyPoint`).
- **Format-critical types with custom serialization** include: `atsc::data::CompressedStream`, `atsc::header::CompressorHeader` (they use manual `to_bytes`/`from_bytes`-style logic; changing their layout or encoding is also format-breaking).

Copilot uses AI. Check for mistakes.
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.

3 participants