docs: rename CLAUDE.md to AGENTS.md and rewrite it - #41
Merged
Merged
Conversation
The dist/ notes described a committed bundle; it is gitignored and built by release.yml onto the release branch. Add the rollout mechanics of that branch, the circular make setup target and the three places pinning the fixture image name. Drop the rtk block: machine-specific tooling belongs in a global config, not in a shared repository.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
CLAUDE.mdbecomesAGENTS.md, withCLAUDE.mdleft as a symlink to it — the convention already used inHexlet/hexlet-asciinemaand in the exercise kit, so any agent finds the file under the name it looks for.The content is rewritten, because three claims in it were wrong or missing:
dist/is not committed. The old text said it is and told the agent to runmake buildbefore every commit.dist/sits in.gitignore;release.ymlbuilds it and force-adds it onto thereleasebranch.@release, andreleaseis built automatically from a greentest.ymlonmaster, so anything landing onmasterreaches every student of every project. That is now the first section after the overview, together with what it implies: merges are a human's call, andrelease.ymlinstalls withnpm install, so even a docs-only commit onmasterrebuilds the shipped bundle.make setupinstalls nothing. The target readssetup: pull setup; make drops the circular dependency, runspulland exits 0. BothREADME.mdand the old doc pointed at it as the install step. Documented here; the target itself is left alone for a separate change.Also added: the fixture image name
hexlet-project-source-ci_enis pinned in three places that have to agree (Makefile,server.js,__tests__/index.test.js), and the artifact glob starts one level belowtmp/artifacts/.Removed
The
rtkinstruction block (about 150 lines). It restatesrtk --help, and it tells every agent in a shared repository to prefix every command with a binary most contributors do not have installed. Machine-specific tooling belongs in a personal global config (rtk init --global).Checks
Documentation only — no source, workflow or
action.ymlchanges, so nothing here reachesreleasebehaviour.🤖 Generated with Claude Code