refactor(procedures): Audit and restructure for actual workflow clarity - #1035
Merged
Conversation
Major restructuring to document actual workflow vs aspirational procedures: Added: - issue-to-pr-workflow.md: Documents the actual mechanical flow from GitHub issue to merged PR - coding-conventions.md: Consolidates micro-procedures (fs paths, uv usage) Updated: - README.md: Restructured to highlight core workflow first, organize by importance Removed experimental/unused procedures: - ears-requirements.md: Never integrated into actual workflow - see-also-pattern.md: Aspirational, not used - non-interactive-execution.md: Not referenced - fs-write-full-paths.md: Consolidated into coding-conventions.md - uv-usage.md: Consolidated into coding-conventions.md This creates an honest representation of our actual workflow: GitHub Issue → Planning Mode → Implementation → PR → Review Principle: systems-stewardship Principle: subtraction-creates-value
Contributor
|
⏳ I'm reviewing this pull request for security vulnerabilities and code quality issues. I'll provide an update when I'm done |
Contributor
|
✅ I finished the code review, and didn't find any security or code quality issues. |
- Labels are auto-assigned by GitHub Action, not manual - Add post-merge workflow steps (the manual process we actually follow) - Strengthen planning mode recommendation as default for all users These changes reflect reality vs aspiration. Principle: systems-stewardship
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.
Summary
Major audit and restructuring of knowledge/procedures to document our ACTUAL workflow rather than aspirational procedures. This creates an honest, mechanical definition of how we really work.
The Problem
Our procedures directory had become a mix of:
The Solution
1. Created Clear Entry Point
issue-to-pr-workflow.mddocuments the complete mechanical flow2. Removed Experiments
Deleted procedures that were aspirational but never integrated:
ears-requirements.md- Cool idea, never used in practicesee-also-pattern.md- Never referencednon-interactive-execution.md- Not part of actual workflow3. Consolidated Micro-Procedures
Created
coding-conventions.mdto consolidate:fs-write-full-paths.mduv-usage.mdThese are important but don't need separate files.
The Result
Now procedures/ clearly shows:
This aligns with "Work the System" - document what you DO, not what you wish you did.
Testing
Principles applied: