You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: docs/WORKFLOW.md
+65-29Lines changed: 65 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -182,51 +182,87 @@ Issue: #<number>
182
182
183
183
## PR Description Format
184
184
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
+
185
189
### Structure
186
190
187
191
```markdown
188
192
## Summary
189
-
Brief overview of what this PR does.
193
+
1-2 sentence overview of what this PR does and why.
190
194
191
-
## Features
192
-
✅ Feature 1
193
-
✅ Feature 2
194
-
✅ Feature 3
195
+
## Problem (if fix)
196
+
Brief description of the bug/issue being fixed.
195
197
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
201
202
202
-
## Performance
203
-
- Metric 1: value
204
-
- Metric 2: value
203
+
## Usage (if new feature)
204
+
```bash
205
+
# Example command or code snippet
206
+
```
205
207
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)
210
212
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
214
216
```
215
-
\`\`\`
216
217
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
220
239
\`\`\`
221
240
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
0 commit comments