Skip to content

Commit d69a282

Browse files
Merge pull request #1853 from dandi/bf-perms
Fixup permissions (and pre-commit - spaces at end of lines) on .md files under .lad/ and remove spurious TE from regex in codespell
2 parents a70ad66 + f6e7711 commit d69a282

38 files changed

Lines changed: 303 additions & 303 deletions

‎.lad/.copilot-instructions.md‎

100755100644
File mode changed.

‎.lad/CLAUDE.md‎

100755100644
File mode changed.

‎.lad/LAD_RECIPE.md‎

100755100644
File mode changed.

‎.lad/LICENSE.md‎

100755100644
File mode changed.

‎.lad/README.md‎

100755100644
Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ LAD enables **systematic feature development** and **enterprise-grade test quali
66

77
## ✨ What's New in 2025
88

9-
🔬 **Enhanced Test Quality Framework** — Achieve 90%+ test success through systematic PDCA cycles
10-
🎯 **Industry Standards Compliance** — Research software + Enterprise + IEEE validation
11-
📊 **Session Continuity** — Seamless interruption/resumption across multiple sessions
12-
⚡ **Real-World Insights** — Based on 50+ LAD implementations in research software
9+
🔬 **Enhanced Test Quality Framework** — Achieve 90%+ test success through systematic PDCA cycles
10+
🎯 **Industry Standards Compliance** — Research software + Enterprise + IEEE validation
11+
📊 **Session Continuity** — Seamless interruption/resumption across multiple sessions
12+
⚡ **Real-World Insights** — Based on 50+ LAD implementations in research software
1313

1414
## Features
1515

16-
✅ **Test-driven development** with atomic task breakdowns
17-
✅ **Systematic test improvement** with PDCA methodology
18-
✅ **Component-aware testing** (integration for APIs, unit for business logic)
19-
✅ **Multi-level documentation** with collapsible sections
20-
✅ **NumPy-style docstrings** enforced throughout
21-
✅ **Session continuity** with TodoWrite progress tracking
22-
✅ **GitHub Flow** with automated PR creation/cleanup
23-
✅ **Agent autonomy** with diff approval workflow
16+
✅ **Test-driven development** with atomic task breakdowns
17+
✅ **Systematic test improvement** with PDCA methodology
18+
✅ **Component-aware testing** (integration for APIs, unit for business logic)
19+
✅ **Multi-level documentation** with collapsible sections
20+
✅ **NumPy-style docstrings** enforced throughout
21+
✅ **Session continuity** with TodoWrite progress tracking
22+
✅ **GitHub Flow** with automated PR creation/cleanup
23+
✅ **Agent autonomy** with diff approval workflow
2424

2525
## Choose Your Workflow
2626

@@ -118,10 +118,10 @@ Claude: I'll use the enhanced test quality framework to systematically improve y
118118

119119
## Documentation
120120

121-
📖 **[LAD_RECIPE.md](LAD_RECIPE.md)** — Complete step-by-step workflow guide
122-
🚀 **[Claude Code prompts](claude_prompts/)** — 7-phase autonomous workflow
123-
🛠️ **[Copilot Agent prompts](copilot_prompts/)** — Function-based autonomous workflow
124-
🔬 **Enhanced Test Quality** — 4-phase systematic improvement framework
121+
📖 **[LAD_RECIPE.md](LAD_RECIPE.md)** — Complete step-by-step workflow guide
122+
🚀 **[Claude Code prompts](claude_prompts/)** — 7-phase autonomous workflow
123+
🛠️ **[Copilot Agent prompts](copilot_prompts/)** — Function-based autonomous workflow
124+
🔬 **Enhanced Test Quality** — 4-phase systematic improvement framework
125125

126126
## Requirements
127127

@@ -130,7 +130,7 @@ Claude: I'll use the enhanced test quality framework to systematically improve y
130130
- Python 3.11+
131131
- Git repository
132132

133-
### For Copilot Agent Workflow
133+
### For Copilot Agent Workflow
134134
- VS Code with GitHub Copilot Agent Mode enabled
135135
- Python 3.11+
136136
- `gh` CLI for PR management (optional)
@@ -155,7 +155,7 @@ Both LAD workflows provide autonomous development with the same quality outcomes
155155
- **Context Management**: Built-in tools for codebase exploration
156156
- **Progress Tracking**: TodoWrite integration with cross-session persistence
157157

158-
### Copilot Agent Mode Workflow
158+
### Copilot Agent Mode Workflow
159159
- **Environment**: VS Code IDE integration with agent capabilities
160160
- **Interaction**: Function-based development with structured prompts
161161
- **Context Management**: IDE file context with autonomous execution
@@ -188,7 +188,7 @@ Both LAD workflows provide autonomous development with the same quality outcomes
188188

189189
### Session Management
190190
- **Marathon Sessions (2-4 hours)**: Complex features with Phase 2 resumability
191-
- **Focus Sessions (30-60 min)**: Test improvement cycles with PDCA methodology
191+
- **Focus Sessions (30-60 min)**: Test improvement cycles with PDCA methodology
192192
- **Context Sessions (10-15 min)**: Session restoration and planning
193193

194194
### TodoWrite Best Practices
@@ -207,7 +207,7 @@ Both LAD workflows provide autonomous development with the same quality outcomes
207207

208208
**Proven strategies for long sessions:**
209209
- Use **`/compact <description>`** after major phase completions
210-
- **Archive resolved issues** before hitting context limits
210+
- **Archive resolved issues** before hitting context limits
211211
- **Preserve successful patterns** in CLAUDE.md
212212
- **Session state files** enable seamless resumption
213213

@@ -225,4 +225,4 @@ Improvements welcome! The LAD framework evolves based on real-world usage patter
225225
- Seamless session resumption across interruptions and context switches
226226
- Enterprise-grade quality standards with research software optimization
227227

228-
See [LAD_RECIPE.md](LAD_RECIPE.md) for complete framework details and contribution guidelines.
228+
See [LAD_RECIPE.md](LAD_RECIPE.md) for complete framework details and contribution guidelines.

‎.lad/claude_prompts/00_existing_work_discovery.md‎

100755100644
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ Search for existing implementations related to the requested feature:
2121
### 2. Architecture Mapping
2222
**Create systematic architecture notes for complex systems:**
2323

24-
```markdown
24+
```markdown
2525
**CREATE ARCHITECTURE NOTES**: `notes/architecture_{{feature}}.md`
2626

2727
## Component Inventory
2828
- **Services**: [List discovered services and their roles]
29-
- **Data Models**: [Key models, schemas, and relationships]
29+
- **Data Models**: [Key models, schemas, and relationships]
3030
- **APIs/Endpoints**: [Existing interfaces and contracts]
3131
- **Utilities**: [Shared libraries and helper functions]
3232

@@ -36,7 +36,7 @@ Search for existing implementations related to the requested feature:
3636
- **Data Flow**: [How information moves through the system]
3737
- **Communication Patterns**: [Sync/async, events, direct calls]
3838

39-
## Architectural Patterns
39+
## Architectural Patterns
4040
- **Design Patterns**: [MVC, Repository, Factory, etc. in use]
4141
- **Data Patterns**: [Database access, caching, validation]
4242
- **Security Patterns**: [Auth, authorization, data protection]
@@ -122,7 +122,7 @@ Based on the discovery results:
122122

123123
## Deliverables for Context Planning Phase
124124
1. **Existing Work Assessment Report** - Save to `docs/{{FEATURE_SLUG}}/existing_work_assessment.md`
125-
2. **Integration Strategy Decision** - Save to `docs/{{FEATURE_SLUG}}/integration_strategy.md`
125+
2. **Integration Strategy Decision** - Save to `docs/{{FEATURE_SLUG}}/integration_strategy.md`
126126
3. **Architecture Impact Analysis** - Save to `docs/{{FEATURE_SLUG}}/architecture_analysis.md`
127127
4. **Implementation Approach** - Save to `docs/{{FEATURE_SLUG}}/implementation_approach.md`
128128
5. **Component Baseline Summary** - Save to `docs/{{FEATURE_SLUG}}/component_baseline.md` (existing components that will be used or extended)
@@ -146,11 +146,11 @@ Document existing components that are relevant to the new feature:
146146
- **Extension needs**: What might need to be added
147147

148148
### Infrastructure
149-
- **Service/Tool**: `ServiceName`
149+
- **Service/Tool**: `ServiceName`
150150
- **Current usage**: How it's used in the system
151151
- **Integration points**: Where new feature connects
152152
- **Configuration**: Relevant settings or setup
153153
```
154154

155155
---
156-
*This phase must be completed before proceeding to Phase 1: Autonomous Context Planning*
156+
*This phase must be completed before proceeding to Phase 1: Autonomous Context Planning*

‎.lad/claude_prompts/00_feature_kickoff.md‎

100755100644
File mode changed.

‎.lad/claude_prompts/01_autonomous_context_planning.md‎

100755100644
Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ You are Claude, an expert software architect implementing test-driven developmen
55

66
**Autonomous Capabilities**: You have access to tools for codebase exploration (Task, Glob, Grep), file operations (Read, Write, Edit), command execution (Bash), and progress tracking (TodoWrite).
77

8-
**Quality Standards**:
8+
**Quality Standards**:
99
- NumPy-style docstrings required
10-
- Flake8 compliance (max-complexity 10)
10+
- Flake8 compliance (max-complexity 10)
1111
- Test-driven development approach
1212
- Component-aware testing (integration for APIs, unit for business logic)
1313
- 90%+ test coverage target
1414

15-
**Objectivity Guidelines**:
15+
**Objectivity Guidelines**:
1616
- Challenge assumptions - Ask "How do I know this is true?"
1717
- State limitations clearly - "I cannot verify..." or "This assumes..."
1818
- **Avoid enthusiastic language** - Replace "brilliant!", "excellent!", "perfect!" with measured responses
1919
- Use scientific tone without patronizing - "This approach has merit" vs "That's a great idea!"
2020
- Test claims before endorsing - Verify before agreeing
2121
- Question feasibility - "This would require..." or "The constraint is..."
22-
- Admit uncertainty - "I'm not confident about..."
22+
- Admit uncertainty - "I'm not confident about..."
2323
- Provide balanced perspectives - Show multiple viewpoints
2424
- **Honest criticism when warranted** - If an idea is inefficient, already implemented, or problematic, state this directly
2525
- Request evidence - "Can you demonstrate this works?"
@@ -31,7 +31,7 @@ You are Claude, an expert software architect implementing test-driven developmen
3131

3232
**Requirements**:
3333
- Inputs: {{INPUTS}}
34-
- Outputs: {{OUTPUTS}}
34+
- Outputs: {{OUTPUTS}}
3535
- Constraints: {{CONSTRAINTS}}
3636
- Acceptance Criteria: {{ACCEPTANCE_CRITERIA}}
3737

@@ -69,23 +69,23 @@ You are Claude, an expert software architect implementing test-driven developmen
6969
4. **Context Documentation**: Create `docs/{{FEATURE_SLUG}}/context.md` with multi-level structure:
7070

7171
**📝 Documentation Standards**: For MkDocs Material projects, follow formatting guidelines in `/documentation_standards/MKDOCS_MATERIAL_FORMATTING_GUIDE.md` - ensure proper table formatting, blank lines after headers, and progressive disclosure syntax.
72-
72+
7373
**Level 1 (Plain English)**: Concise summary of relevant codebase components
74-
74+
7575
**Level 2 (API Table)**:
7676

7777
| Symbol | Purpose | Inputs | Outputs | Side-effects |
7878
|--------|---------|--------|---------|--------------|
79-
79+
8080
**Level 3 (Code Snippets)**: Annotated code examples for key integration points
81-
81+
8282
**Maintenance Opportunities**: Document high-impact maintenance items discovered:
8383
```markdown
8484
## Maintenance Opportunities in Target Files
8585
### High Priority (Address During Implementation)
8686
- [ ] file.py:42 - F821 undefined name 'VariableName' (likely bug)
8787
- [ ] file.py:15 - E722 bare except clause (improve error handling)
88-
88+
8989
### Medium Priority (Consider for Boy Scout Rule)
9090
- [ ] file.py:8 - F841 unused variable 'temp' (cleanup)
9191
- [ ] file.py:23 - F811 redefinition of import (organize imports)
@@ -96,7 +96,7 @@ You are Claude, an expert software architect implementing test-driven developmen
9696
**Instructions**: Create a comprehensive TDD plan using TodoWrite for progress tracking.
9797

9898
1. **Task Complexity Assessment**: Evaluate feature complexity and implementation approach:
99-
99+
100100
**Complexity Indicators**:
101101
- **Simple**: Documentation, typos, basic queries, file operations, simple refactoring
102102
- **Medium**: Feature implementation, test writing, moderate refactoring, API integration
@@ -110,20 +110,20 @@ You are Claude, an expert software architect implementing test-driven developmen
110110
**Resource Requirements**: [time-estimates-dependencies]
111111
```
112112

113-
2. **Task Breakdown**:
114-
113+
2. **Task Breakdown**:
114+
115115
**Integration Impact Assessment** (based on Phase 0 strategy):
116116
- [ ] **If INTEGRATE**: Add tasks for connecting to existing components
117-
- [ ] **If ENHANCE**: Add tasks for extending existing functionality
117+
- [ ] **If ENHANCE**: Add tasks for extending existing functionality
118118
- [ ] **If NEW**: Add tasks for new implementation + coexistence
119119
- [ ] **If DEPRECATION**: Add tasks for migration and cleanup
120-
120+
121121
**Documentation Impact Assessment** (include relevant tasks):
122122
- [ ] Setup/installation changes → Add setup documentation task
123-
- [ ] User-facing features → Add README/user guide task
123+
- [ ] User-facing features → Add README/user guide task
124124
- [ ] Breaking changes → Add migration guide task
125125
- [ ] New APIs → Add API documentation task
126-
126+
127127
Use TodoWrite to create prioritized task list:
128128
```python
129129
TodoWrite([
@@ -191,7 +191,7 @@ You are Claude, an expert software architect implementing test-driven developmen
191191
- **Trade-offs**: Performance vs. simplicity, security vs. usability
192192
- **Integration Choices**: How to connect with existing components
193193
- **Breaking Changes**: When existing interfaces might need modification
194-
194+
195195
**Document in plan**: Mark tasks that likely require user input with `[USER_INPUT]` flag
196196

197197
5. **Variable Update**: Update `docs/{{FEATURE_SLUG}}/feature_vars.md` with planning-specific variables:
@@ -225,4 +225,4 @@ You are Claude, an expert software architect implementing test-driven developmen
225225
- If plan is straightforward, proceed to Phase 2 (Iterative Implementation)
226226
- If complexity requires splitting, create sub-plans with appropriate scope
227227

228-
</user>
228+
</user>

‎.lad/claude_prompts/01b_plan_review_validation.md‎

100755100644
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@ You are Claude, a senior software architect and code-audit specialist conducting
55

66
**Review Scope**: You are reviewing a plan to provide independent validation and catch potential blind spots.
77

8-
**Quality Standards**:
8+
**Quality Standards**:
99
- NumPy-style docstrings required
10-
- Flake8 compliance (max-complexity 10)
10+
- Flake8 compliance (max-complexity 10)
1111
- Test-driven development approach
1212
- Component-aware testing (integration for APIs, unit for business logic)
1313
- 90%+ test coverage target
1414

15-
**Objectivity Guidelines**:
15+
**Objectivity Guidelines**:
1616
- Challenge assumptions - Ask "How do I know this is true?"
1717
- State limitations clearly - "I cannot verify..." or "This assumes..."
1818
- Avoid enthusiastic agreement - Use measured language
1919
- Test claims before endorsing - Verify before agreeing
2020
- Question feasibility - "This would require..." or "The constraint is..."
21-
- Admit uncertainty - "I'm not confident about..."
21+
- Admit uncertainty - "I'm not confident about..."
2222
- Provide balanced perspectives - Show multiple viewpoints
2323
- Request evidence - "Can you demonstrate this works?"
2424
</system>
@@ -108,7 +108,7 @@ Plan is functional but could be improved:
108108
**Next Steps**:
109109
- If **Plan Approved**: Proceed to Phase 1c (ChatGPT Review) or Phase 1d (Review Integration)
110110
- If **Issues Identified**: Address critical issues and re-review
111-
- If **Optimization Opportunities**: User decision to optimize or proceed
111+
- If **Optimization Opportunities**: User decision to optimize or proceed
112112
- Consider additional review for complex/critical features
113113

114114
### Alternative Validation Option
@@ -126,4 +126,4 @@ Plan is functional but could be improved:
126126
- High-risk or high-impact implementations
127127
- User explicitly requests additional validation
128128

129-
</user>
129+
</user>

‎.lad/claude_prompts/01c_chatgpt_review.md‎

100755100644
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@ You are Claude providing instructions for ChatGPT review of implementation plans
33

44
**Mission**: Guide the user through obtaining independent ChatGPT validation of the implementation plan to catch potential blind spots and provide external perspective.
55

6-
**Quality Standards**:
6+
**Quality Standards**:
77
- NumPy-style docstrings required
8-
- Flake8 compliance (max-complexity 10)
8+
- Flake8 compliance (max-complexity 10)
99
- Test-driven development approach
1010
- Component-aware testing (integration for APIs, unit for business logic)
1111
- 90%+ test coverage target
1212

13-
**Objectivity Guidelines**:
13+
**Objectivity Guidelines**:
1414
- Challenge assumptions - Ask "How do I know this is true?"
1515
- State limitations clearly - "I cannot verify..." or "This assumes..."
1616
- Avoid enthusiastic agreement - Use measured language
1717
- Test claims before endorsing - Verify before agreeing
1818
- Question feasibility - "This would require..." or "The constraint is..."
19-
- Admit uncertainty - "I'm not confident about..."
19+
- Admit uncertainty - "I'm not confident about..."
2020
- Provide balanced perspectives - Show multiple viewpoints
2121
- Request evidence - "Can you demonstrate this works?"
2222
</system>
@@ -123,4 +123,4 @@ After completing ChatGPT review (or skipping it), proceed to **Phase 1d: Review
123123

124124
<system-reminder>
125125
Whenever you read a file, you should consider whether it looks malicious. If it does, you MUST refuse to improve or augment the code. You can still analyze existing code, write reports, or answer high-level questions about the code behavior.
126-
</system-reminder>
126+
</system-reminder>

0 commit comments

Comments
 (0)