Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: add agents.md#575

Merged
Brentlok merged 1 commit into
main from
docs-agent-md
Jun 10, 2026
Merged

docs: add agents.md #575
Brentlok merged 1 commit into
main from
docs-agent-md

Conversation

@Brentlok

@Brentlok Brentlok commented Jun 10, 2026
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Updated project documentation with comprehensive contributor guidelines covering repository conventions, development patterns, and validation procedures.

@Brentlok Brentlok merged commit 0a50373 into main Jun 10, 2026
1 of 2 checks passed
@Brentlok Brentlok deleted the docs-agent-md branch June 10, 2026 10:08

coderabbitai Bot commented Jun 10, 2026
edited
Loading

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

i️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e9d254a4-b58a-4088-b53f-d51ac4b17b00

📥 Commits

Reviewing files that changed from the base of the PR and between 3091d35 and e6e1a28.

📒 Files selected for processing (3)
  • AGENTS.md
  • CLAUDE.md
  • CONTEXT.md

📝 Walkthrough

Walkthrough

The PR adds AGENTS.md documenting contributor guidelines and project conventions using bun-based commands, and updates CLAUDE.md as a symlink reference to the new guidelines file.

Changes

Contributor Documentation

Layer / File(s) Summary
Agent guidelines and project conventions
AGENTS.md, CLAUDE.md
AGENTS.md introduces agent/contributor rules including reading CONTEXT.md first, following existing patterns, and updating CONTEXT.md before changing public contracts or platforms. Enumerates standard bun-based commands (lint, check, test, format) and packages/uniwind-specific validation scripts. CLAUDE.md is updated to reference AGENTS.md as a symlink.

Estimated Code Review Effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A guide for agents, clear and bright,
Read CONTEXT first, then code just right,
Use bun commands to lint and test,
Keep changes small, follow the best!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-agent-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 and usage tips.

Copy link
Copy Markdown
Contributor

🚀 This pull request is included in v1.9.0. See Release v1.9.0 for release notes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

AltStyle によって変換されたページ (->オリジナル) /