[docs] Consolidate developer specs into dev.md v4.8#23671
Merged
Conversation
…low refactoring - Add CLI Breaking Changes subsection to Release Management (from breaking-cli-rules.md): breaking vs non-breaking categories, decision tree, changeset format, review checklist, JSON output standards - Add Workflow Size and Refactoring subsection to Workflow Patterns (from workflow-refactoring-patterns.md): size guidelines, imports module extraction pattern, refactoring checklist, anti-patterns - Add 2 new Related Documentation links in Additional Resources - Bump version to 4.8, update Last Updated to 2026-03-31 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
github-actions
bot
added
automation
documentation
pelikhan
deleted the
docs/consolidation-v4.8-2026-03-31-650343683f0f9522
branch
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.
Incorporates two previously uncovered spec files into the consolidated developer instructions.
Changes Made
breaking-cli-rules.md— breaking vs. non-breaking change categories, a 5-step decision tree, changeset format examples for major/minor/patch, a reviewer checklist, and JSON output stability standardsworkflow-refactoring-patterns.md— size guidelines (target 200–400 lines, refactor above 600), theimports:module extraction pattern with shared module types, a refactoring checklist, and anti-patternsAnalysis
63 markdown files were reviewed in
scratchpad/. Of these, 2 had not yet been incorporated intodev.md:breaking-cli-rules.mdworkflow-refactoring-patterns.mdRemaining unlinked files (e.g.,
agent-sessions.md,smoke-test-*.md,ubuntulatest.md) are either planning documents, test artifacts, or implementation-specific references not suited for inline consolidation.Validation
scratchpad/dev.mdcompiles as valid Markdown