Refactor testing documentation into organized folder structure #93
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.
The
testing.mdfile grew to 652 lines covering multiple distinct topics (unit testing, resource management, commands, clock service, pre-commit integration). This refactoring splits it into focused, single-concern documents for better maintainability and discoverability.Changes
New Structure:
Cross-Reference Updates:
.github/copilot-instructions.md,README.md,tests/ai_enforcement.rs, and docs incontributing/,refactors/,features/testing.mdreferences totesting/directory linksdocs/contributing/testing.mdContent: All 652 lines preserved with no semantic changes, only reorganized into 6 focused files (663 lines total with section headers).
Original prompt
This section details on the original issue you should resolve
<issue_title>Refactor testing documentation structure</issue_title>
<issue_description>Parent Epic: #85
Overview
Refactor the testing documentation from a single large
testing.mdfile (652 lines) into a well-organizedtesting/folder structure with separate files for different concerns. This refactoring improves maintainability, discoverability, and sets the stage for adding new coverage documentation without mixing concerns.Why This Matters: The current
testing.mdfile has grown to over 650 lines and covers multiple distinct topics (unit testing, commands testing, E2E testing, pre-commit integration, etc.). Splitting this into separate focused files makes the documentation easier to navigate, maintain, and extend.Goals
docs/contributing/testing/directory structuretesting.mdinto focused, single-concern documentsREADME.mdas the testing documentation entry pointtesting.mdthroughout the projectProposed Structure
Content Mapping
README.md(Main Entry Point)unit-testing.mdit_should_prefix)resource-management.mdtesting-commands.mdclock-service.mdpre-commit-integration.mdImplementation Plan
Phase 1: Create Directory Structure (5 minutes)
docs/contributing/testing/directoryPhase 2: Create README.md Entry Point (20 minutes)
docs/contributing/testing/README.mdPhase 3: Create Specialized Documentation Files (60 minutes)
unit-testing.md(lines ~5-60 fromtesting.md)resource-management.md(lines ~61-105)testing-commands.md(lines ~368-572)clock-service.md(lines ~258-367)pre-commit-integration.md(lines ~584-652)Phase 4: Update Cross-References (30 minutes)
testing.mdreferencesPhase 5: Remove Old File (5 minutes)
docs/contributing/testing.mdPhase 6: Validation (20 minutes)
Acceptance Criteria
docs/contributing/testing/directory exists with 6 files totaltesting.mdis preserved (no deletions)README.mdserves as clear entry point with navigationdocs/contributing/testing.mdis removedNotes
Comments on the Issue (you are @copilot in this section)
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.