new jira ticket writing skill and details on paying attention to names
Some checks failed
CI / test (push) Has been cancelled

This commit is contained in:
John Lamb
2026-02-25 08:47:48 -06:00
parent 8dfcfcfb09
commit 36ae861046
6 changed files with 232 additions and 3 deletions

View File

@@ -465,6 +465,22 @@ end
### 6. Final Review & Submission
**Naming Scrutiny (REQUIRED for any plan that introduces new interfaces):**
When the plan proposes new functions, classes, variables, modules, API fields, or database columns, scrutinize every name:
| # | Check | Question |
|---|-------|----------|
| 1 | **Caller's perspective** | Does the name describe what it does, not how? |
| 2 | **No false qualifiers** | Does every `_with_X` / `_and_X` reflect a real choice? |
| 3 | **Visibility matches intent** | Should private helpers be private? |
| 4 | **Consistent convention** | Does the pattern match existing codebase conventions? |
| 5 | **Precise, not vague** | Could this name apply to ten different things? (`data`, `manager`, `handler` = red flags) |
| 6 | **Complete words** | No ambiguous abbreviations? |
| 7 | **Correct part of speech** | Functions = verbs, classes = nouns, booleans = assertions? |
Bad names in plans become bad names in code. Catching them here is cheaper than catching them in review.
**Pre-submission Checklist:**
- [ ] Title is searchable and descriptive
@@ -472,6 +488,7 @@ end
- [ ] All template sections are complete
- [ ] Links and references are working
- [ ] Acceptance criteria are measurable
- [ ] All proposed names pass the naming scrutiny checklist above
- [ ] Add names of files in pseudo code examples and todo lists
- [ ] Add an ERD mermaid diagram if applicable for new model changes