Skip to content

Commit 360e2cb

Browse files
committed
docs(workflow): update PR description format to be concise
Update The Drill to reflect concise, focused PR descriptions rather than verbose ones. Context is important but excessive noise makes PRs harder to parse. Principles: - Focus on essential information - Include the 'why' and key decisions - Provide usage examples and verification details - Exclude verbose change logs and obvious information Based on PR #125 as a good example.
1 parent 20a15eb commit 360e2cb

File tree

1 file changed

+65
-29
lines changed

1 file changed

+65
-29
lines changed

docs/WORKFLOW.md

Lines changed: 65 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -182,51 +182,87 @@ Issue: #<number>
182182

183183
## PR Description Format
184184

185+
### Principles
186+
187+
**Keep it concise and meaningful** - Context is important, but excessive noise makes PRs harder to parse. Focus on essential information that helps reviewers and provides future reference.
188+
185189
### Structure
186190

187191
```markdown
188192
## Summary
189-
Brief overview of what this PR does.
193+
1-2 sentence overview of what this PR does and why.
190194

191-
## Features
192-
✅ Feature 1
193-
✅ Feature 2
194-
✅ Feature 3
195+
## Problem (if fix)
196+
Brief description of the bug/issue being fixed.
195197

196-
## Testing
197-
- ✅ X tests, all passing
198-
- ✅ Y% statement coverage (Z% function coverage)
199-
- ✅ Tested: scenarios covered
200-
- ⚠️ Uncovered: what's not covered and why
198+
## Solution
199+
- Key change 1
200+
- Key change 2
201+
- Key change 3
201202

202-
## Performance
203-
- Metric 1: value
204-
- Metric 2: value
203+
## Usage (if new feature)
204+
```bash
205+
# Example command or code snippet
206+
```
205207

206-
## Documentation
207-
- ✅ README with examples
208-
- ✅ API reference
209-
- ✅ Usage guide
208+
## Testing
209+
-X tests passing (Y new tests)
210+
-Verified on: specific scenario/repository
211+
- ⚠️ Known limitations (if any)
210212

211-
## Example Usage
212-
```typescript
213-
// Clear, runnable example
213+
## Changes
214+
- N commits: brief description of commit types
215+
- Packages affected: list relevant packages
214216
```
215-
\`\`\`
216217
217-
## Coverage Report
218-
\`\`\`
219-
Coverage table
218+
### Good Example
219+
220+
```markdown
221+
## Summary
222+
Fixes ENOBUFS error when indexing repositories with many GitHub issues/PRs.
223+
224+
## Problem
225+
\`dev index\` would fail with \`ENOBUFS\` on repositories with extensive GitHub
226+
activity due to buffer overflow (default 1MB buffer, fetching 1000+ items).
227+
228+
## Solution
229+
- Increased maxBuffer: 1MB → 50MB for issue/PR fetching
230+
- Lowered default limit: 1000 → 500 items per type
231+
- Added \`--gh-limit <number>\` CLI flag for customization
232+
- Improved error messages with actionable suggestions
233+
234+
## Usage
235+
\`\`\`bash
236+
dev index # Default (500 items)
237+
dev index --gh-limit 200 # Large repos
238+
dev index --gh-limit 100 # Very active repos
220239
\`\`\`
221240
222-
## Known Limitations
223-
- ⚠️ Limitation 1
224-
- ⚠️ Limitation 2
241+
## Testing
242+
- ✅ All 1100+ tests passing
243+
- ✅ 23 new fetcher utility tests
244+
- ✅ Verified on 6,989 file repo with 1,000 issues/PRs
225245
226-
## Closes
227-
Closes #<issue-number>
246+
## Changes
247+
- 6 commits: fix implementation, tests, documentation, changeset, website
248+
- Patches: \`@lytics/dev-agent\`, \`@lytics/dev-agent-cli\`, \`@lytics/dev-agent-subagents\`
228249
```
229250

251+
### What to Exclude
252+
253+
**Don't include:**
254+
- ❌ Verbose change logs (commits already document this)
255+
- ❌ Line-by-line code explanations
256+
- ❌ Coverage tables (CI provides this)
257+
- ❌ Full test lists (test files document this)
258+
- ❌ Obvious information that's in the code
259+
260+
**Instead:**
261+
- ✅ Focus on the "why" and key decisions
262+
- ✅ Usage examples for new features
263+
- ✅ Verification details for bug fixes
264+
- ✅ Brief overview of what changed
265+
230266
## Testing Standards
231267

232268
### Coverage Goals

0 commit comments

Comments
 (0)