Repository navigation
Position the documentation around AI Design by Contract - #74
Merged
Merged
Conversation
The README now opens with the AI workflow: rules in plain language, the contracts an agent writes from them, and the violation that names the broken rule. New sections explain why contracts matter for AI-written code, how the skill works (specification, rules, contracts, code, checker, tests, report), a quick start that installs the skill, what the agent delivers and the contract checker. The existing reference follows as "The contract language", and the old "AI coding agents" section is folded into the top. The Composer description and keywords, AGENTS.md and the CHANGELOG intro follow the same positioning. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FxhC1FD8xw9sMh2etSB3ir
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
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.
This is a follow-up to php-deal/framework#73. The README now presents PhpDeal as AI Design by Contract for PHP from its first line.
README
The new opening shows the whole idea in one screen:
New sections:
The existing reference follows unchanged under The contract language: setup, contracts, expressions, violations, PHPStan, production. The old "AI coding agents" section is folded into the top, and the separate Installation section into Quick start.
Elsewhere
composer.json: new description and keywords (ai,ai-agents,agent-skills,claude-code,specification,contract-based-testing). Packagist shows these.AGENTS.md: the project summary, plus a rule to present new features from the AI workflow first.CHANGELOG.md: the 2.0.0 intro.Checks
composer testpasses.Generated by Claude Code