Skip to content

docs(core): add Basic Machines agent style guidance#921

Merged
phernandez merged 2 commits into
mainfrom
codex/basic-machines-agent-style-main
Jun 8, 2026
Merged

docs(core): add Basic Machines agent style guidance#921
phernandez merged 2 commits into
mainfrom
codex/basic-machines-agent-style-main

Conversation

@phernandez

Copy link
Copy Markdown
Member

Summary

  • add concise Basic Machines programming style guidance to AGENTS.md
  • add a fuller Basic Memory engineering style guide under docs/
  • add a repo-local basic-machines-review skill and expose it to Claude Code

Test Plan

  • git diff --check
  • verified CLAUDE.md -> AGENTS.md
  • verified basic-machines-review skill symlink resolves
  • verified branch contains only the style-guidance commit against main
  • verified no product skills/ files changed

Signed-off-by: phernandez <paul@basicmachines.co>
@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Claude finished @phernandez's task in 1m 29s —— View job


PR Review: docs(core): add Basic Machines agent style guidance

Tasks

  • Gather context and read changed files
  • Review SKILL.md
  • Review AGENTS.md changes
  • Review ENGINEERING_STYLE.md
  • Verify symlink
  • Run checklist and post summary

Finding: .claude/skills/basic-machines-review is a regular file, not a symlink

severity: medium | .claude/skills/basic-machines-review | Structural / tooling

The existing skill symlinks in .claude/skills/ (adversarial-review, instrumentation) are stored as proper git symlinks (mode 120000). The new basic-machines-review entry is stored as a regular blob with the path ../../.agents/skills/basic-machines-review as its text content. On a fresh checkout it will appear as a plain text file rather than a symlink, and Claude Code will not resolve it as a skill.

Confirmed: git cat-file -t HEAD:.claude/skills/basic-machines-review returns blob — correct for a git symlink, but ls -la .claude/skills/ after checkout shows only adversarial-review and instrumentation; basic-machines-review is absent from disk, meaning git treated it as a regular file and wrote it nowhere (or wrote it as a text file).

Fix: Re-create it as a proper symlink and re-commit:

cd .claude/skills
git rm basic-machines-review
ln -s ../../.agents/skills/basic-machines-review basic-machines-review
git add basic-machines-review
git commit --amend --no-edit -s

After amending, git ls-tree HEAD .claude/skills/basic-machines-review should show mode 120000.

Fix this →


Content Quality

docs/ENGINEERING_STYLE.md — well-structured, concise, and consistent with CLAUDE.md guidance. Sections cover design center, types/data, control flow/resources, testing, and comments/names. No issues.

AGENTS.md Programming Style section — cleanly summarizes ENGINEERING_STYLE.md for agents. Appropriate level of brevity for an in-context summary. No issues.

.agents/skills/basic-machines-review/SKILL.md — solid review rubric. The seven risk categories (cognitive load, change propagation, knowledge duplication, accidental complexity, dependency direction, domain model distortion, test oracle quality) are concrete and falsifiable. The reporting format (severity | file:line | risk category | claim) matches the adversarial-review skill's output style. No issues.


Checklist

Item Status
Follows Basic Memory coding conventions (CLAUDE.md)
No Python code changed — type annotations N/A
100-character line length maintained
No commented-out code blocks
Documentation updated
CLAUDE.md (AGENTS.md) updated with Programming Style section
No hardcoded secrets or credentials
No emojis/unicode in output
Skill symlink resolves correctly on checkout ❌ Regular file, not a git symlink
Unit/integration tests N/A (docs-only change)
Test coverage N/A (docs-only change)
Alembic migration N/A
Database/MCP/architecture changes N/A

Summary: One issue to fix: the .claude/skills/basic-machines-review entry needs to be a proper git symlink (mode 120000) rather than a regular text file — otherwise Claude Code won't resolve the skill. All content (style guide, AGENTS.md update, SKILL.md rubric) is clean and ready.

Signed-off-by: phernandez <paul@basicmachines.co>
@phernandez

Copy link
Copy Markdown
Member Author

Reviewed the feedback and pushed follow-up commit b3d1b41c.

  • Verified .claude/skills/basic-machines-review is already a git symlink: git ls-tree HEAD .claude/skills/basic-machines-review reports mode 120000.
  • Added a severity legend to basic-machines-review.
  • Clarified that reviewers should apply only the active repo's scope guidance.
  • Reduced AGENTS duplication by making Programming Style the canonical fail-fast/type-safety guidance.

Verification:

  • git diff --check HEAD~1..HEAD
  • git ls-tree HEAD .claude/skills/basic-machines-review
  • PR range still only touches AGENTS, docs/ENGINEERING_STYLE.md, and the repo-local review skill files.

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Claude finished @phernandez's task in 2m 35s —— View job


PR Review: docs(core): add Basic Machines agent style guidance

Tasks

  • Gather context
  • Verify symlink fix (git ls-tree mode check)
  • Review SKILL.md content
  • Review AGENTS.md changes
  • Review ENGINEERING_STYLE.md
  • Run checklist and post summary

Symlink Fix Verified ✅

git ls-files -s .claude/skills/basic-machines-review confirms mode 120000 — the follow-up commit b3d1b41 correctly fixed the original finding. The on-disk absence (D in git status) is a CI checkout artifact; the other two symlinks check out fine and the git object is authoritative.


Content Quality

docs/ENGINEERING_STYLE.md — Clean structure across five sections (Design Center, Types And Data, Control Flow And Resources, Testing And Verification, Comments And Names). Content is well-aligned with the existing codebase conventions. No issues.

AGENTS.md diff — The three redundant one-liners (No speculative getattr, Fail fast, No fallback logic) are removed and consolidated under the new "House style is canonical" bullet. The new "Programming Style" section provides a useful 7-bullet summary that correctly defers to docs/ENGINEERING_STYLE.md for depth. 100-character line limit maintained throughout. No issues.

.agents/skills/basic-machines-review/SKILL.md — Solid rubric. The seven risk categories (cognitive load, change propagation, knowledge duplication, accidental complexity, dependency direction, domain model distortion, test oracle quality) are concrete and falsifiable. The new severity legend (high/medium/low with use-case descriptions) directly addresses the prior review's feedback. The "apply only the active repo's scope guidance" clarification is good hygiene for a shared-harness skill. No issues.


Checklist

Item Status
Follows Basic Memory coding conventions (CLAUDE.md)
Python 3.12+ type annotations / SQLAlchemy / FastAPI N/A — docs only
100-character line length maintained
No commented-out code blocks
Documentation updated
AGENTS.md updated with Programming Style section
No hardcoded secrets or credentials
No emojis/unicode in console or log output
Skill symlink is mode 120000 (proper git symlink) ✅ Fixed in b3d1b41
Unit/integration tests N/A — docs only
100% test coverage N/A — docs only
Alembic migration N/A
Windows-compatible file path comparisons N/A — docs only

Summary: All previous findings addressed. The symlink is correctly stored as mode 120000 in git, content across all four files is clean and consistent, and the PR scope remains docs-only. Ready to merge.

@phernandez phernandez merged commit 4128cac into main Jun 8, 2026
24 of 25 checks passed
@phernandez phernandez deleted the codex/basic-machines-agent-style-main branch June 8, 2026 22:09
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.

1 participant