Skip to content

docs(contributing): contributor and agent guidelines - #16

Merged
ShadobaDev merged 2 commits into
mainfrom
docs/agent-guidelines
Nov 7, 2026
Merged

ShadobaDev merged 2 commits into
mainfrom
docs/agent-guidelines

Conversation

@ShadobaDev

Copy link
Copy Markdown
Owner

Summary

  • CLAUDE.md: a short map for coding agents: the library's invariants, where each topic is
    documented, and the build and test commands. All rules stay in the human docs.
  • CONTRIBUTING.md: build and test, what a change includes, commit message format,
    CHANGELOG rules, and a section on AI-assisted contributions (the Co-Authored-By trailer).
  • docs/CODING_STYLE.md: follows the shared C++ style template. The class-size exceptions
    and the coverage rules moved verbatim to its "This project" section.
  • docs/TODO.md: two entries: backfill the page size for inputs rendered before 0.5.0, and
    the CLI rejects a directory whose name is not ASCII (Windows).
  • Wiki pin: five more Critical Design Rules (a workspace is what its file says, the library
    never chooses where files live, the library guards its own invariants, one channel per
    datum, enums and callbacks are additive); "C++20" instead of "C++ 17/20".

No code changes.

🤖 Generated with Claude Code

ShadobaDev and others added 2 commits November 7, 2026 14:49
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
PlateMaker's class-size exceptions and coverage rules move to its
"This project" section.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ShadobaDev
ShadobaDev merged commit c7eda3b into main Nov 7, 2026
4 checks passed
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