8000 Rename CLAUDE.md to AGENTS.md, add symlink, and update build command by 0chroma · Pull Request #188 · gominimal/pkgs · GitHub
[go: up one dir, main page]

Skip to content

Rename CLAUDE.md to AGENTS.md, add symlink, and update build command - #188

Merged
0chroma merged 4 commits into
mainfrom
agents-claude-symlink
May 21, 2026
Merged

0chroma merged 4 commits into
mainfrom
agents-claude-symlink

Conversation

@0chroma
@0chroma 0chroma commented May 21, 2026 •
Copy link
Copy Markdown
Contributor

Summary

This PR renames the repository's instruction/guidance file from CLAUDE.md to AGENTS.md, sets up CLAUDE.md as a symlink pointing to AGENTS.md, and updates an outdated build command reference in the file.

Changes

  • Rename & Symlink:
    • Renamed CLAUDE.md to AGENTS.md (to reflect its general purpose for developer agents).
    • Created a symbolic link CLAUDE.md pointing to AGENTS.md to maintain compatibility with tools/agents expecting CLAUDE.md.
  • Documentation Update:
    • Updated the outdated min patched-pkg command to min patched-build in AGENTS.md.

Summary by CodeRabbit

Documentation

  • Updated repository guidance documentation for the Minimal packaging system. Now includes comprehensive coverage of Nickel-based package layout, build environment declaration, dependency management (build vs runtime), build scripting conventions, source handling, output categorization, and package metadata. Added step-by-step workflows for creating packages and expanded troubleshooting FAQ for common build errors.

Review Change Stack

@coderabbitai
coderabbitai Bot commented May 21, 2026 •
Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@0chroma has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 49 minutes and 21 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e8c40488-7d27-4a6c-8b1d-ed5702678549

📥 Commits

Reviewing files that changed from the base of the PR and between aa24ff3 and f73a5c7.

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

Walkthrough

Added AGENTS.md, a comprehensive guide for Claude Code operations in the Minimal packaging repository, documenting repository layout, package declaration patterns, build conventions, creation workflows with examples, and troubleshooting guidance. Removed the previous CLAUDE.md.

Changes

AGENTS.md Documentation for Claude Code

Layer / File(s) Summary
Introduction and Repository Structure
AGENTS.md
Introduces AGENTS.md and its purpose; defines repository layout conventions (Nickel syntax, object paths), harness types, and harness responsibilities in the build system.
Package Declaration and Build Specifications
AGENTS.md
Specifies how to write package build.ncl files with imports, dependency roles, subset usage, build-step conventions, source code handling, output declarations with typed metadata, and additional fields like needs and prebuilt.
Package Creation Workflow and Examples
AGENTS.md
Provides step-by-step package creation workflow (steps 0–2) with illustrative build.ncl examples for C library, Go tool, and Rust tool, including upstream URL and SHA256 selection guidance.
Build Implementation and Troubleshooting
AGENTS.md
Covers remaining workflow steps (3–6) for authoring build.sh with install-to-$OUTPUT_DIR patterns across build systems, running validation commands, and FAQ with remediation for common build errors and toolchain issues.

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested Reviewers

  • mitodrummer
  • twitchyliquid64

Poem

🐰 A guide for Code Claude we lay,
From package birth to validation day,
With workflows clear and errors solved,
In Nickel scripts, our builds evolved,
Let agents build with confidence gay! 🚀

🚥 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 accurately describes the main changes: renaming CLAUDE.md to AGENTS.md, adding a symlink, and updating a build command. It clearly summarizes the primary objectives of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agents-claude-symlink

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.

@coderabbitai coderabbitai Bot left a comment
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Around line 645-647: Update the documentation entries that still reference the
old command string "min patched-pkg" to the new command "min patched-build":
search for literal occurrences of "min patched-pkg" and any inline mentions of
"patched-pkg" in AGENTS.md (including the examples and explanatory sentences
around lines noted) and replace them with "min patched-build" and
"patched-build" respectively, and update the accompanying instructional
sentences (e.g., "keep iterating running the `patched-pkg` and `check` commands"
→ "keep iterating running the `patched-build` and `check` commands") so all
examples and prose consistently use the new command name.
- Around line 678-680: The fenced code block containing the line "error: other:
resolving dep '<package>' by name: not found" is unlabeled and trips markdown
linting; update that fence to label the block as text (change ``` to ```text) so
the block is language-specified and linting passes.
- Around line 1-3: The document header still reads "# CLAUDE.md" after the file
was renamed to AGENTS.md; update the top-level heading and any first-line intro
that references "CLAUDE.md" so they consistently use "AGENTS.md" (i.e., change
the heading "# CLAUDE.md" to "# AGENTS.md" and update the opening sentence that
mentions the filename or canonical name), leaving the rest of the intro about
guidance to Claude Code intact.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6b635ddf-5bdc-44df-800b-57cd585e8c91

📥 Commits

Reviewing files that changed from the base of the PR and between b0b729b and aa24ff3.

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

Comment thread AGENTS.md Resolved
Comment thread AGENTS.md Resolved
Comment thread AGENTS.md Resolved
0chroma and others added 2 commits May 20, 2026 17:55
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@0chroma
0chroma enabled auto-merge May 21, 2026 01:08
@0chroma
0chroma added this pull request to the merge queue May 21, 2026
Merged via the queue into main with commit 64e8341 May 21, 2026
3 checks passed
@0chroma
0chroma deleted the agents-claude-symlink branch May 21, 2026 01:16
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

0