mirror of
https://github.com/n8n-io/n8n.git
synced 2026-10-11 22:50:06 +00:00
docs: Restructure Linear triage report for readability (#35095)
This commit is contained in:
@@ -30,7 +30,7 @@ Provide thorough analysis and sufficient context for smooth handover - not imple
|
||||
- Analyze dependencies and cross-package impacts in TypeScript monorepo structure
|
||||
|
||||
### 3. Context Gathering
|
||||
- **Implementation Area**: Clearly identify FRONTEND / BACKEND / BOTH / NODE ECOSYSTEM
|
||||
- **Implementation Area**: Clearly identify FRONTEND / BACKEND / BOTH / NODE / INFRA
|
||||
- **Technical Scope**: Specific packages, files, workflow components, and code areas involved
|
||||
- **User Impact**: Affected user segments, workflow types, and severity assessment
|
||||
- **Business Context**: Customer reports, enterprise vs community impact, node usage patterns
|
||||
@@ -57,14 +57,64 @@ Provide thorough analysis and sufficient context for smooth handover - not imple
|
||||
|
||||
## Investigation Output
|
||||
|
||||
Provide comprehensive analysis including:
|
||||
The report is usually read by a human skimming a Linear ticket, so lead with the
|
||||
verdict and with what you need from them. Use these sections, in this order,
|
||||
with `##` headings.
|
||||
|
||||
1. **Root Cause Analysis**: Specific technical reason with commit/file references and ecosystem context
|
||||
2. **Implementation Scope**: FRONTEND/BACKEND/BOTH/NODE with exact file paths and affected components
|
||||
3. **Impact Assessment**: User segments affected, workflow scenarios impacted, and severity level
|
||||
4. **Technical Context**: Architecture areas involved, workflow engine implications, node dependencies, related systems
|
||||
5. **Investigation Trail**: Commits examined, patterns identified, related issues, ecosystem considerations
|
||||
6. **Handover Intelligence**: Everything needed for developer or implementation agent to proceed immediately with full context
|
||||
### 1. TL;DR
|
||||
|
||||
Always first, three to five bullets, no preamble. Cover the verdict (confirmed /
|
||||
not reproducible / works as designed), the root cause in one line, severity,
|
||||
rough estimate, and the one thing the reader does not already know from the
|
||||
ticket. Someone who reads only this section should be able to decide whether to
|
||||
schedule the work.
|
||||
|
||||
### 2. Decisions Needed
|
||||
|
||||
Open questions go near the top, not buried at the end. **Every question names
|
||||
its owner** - the person or team who can answer it, inferred from the ticket's
|
||||
assignee, reporter, labels, or the owning team (security, the reporter, the
|
||||
frontend team). An unaddressed question does not get answered, so when you
|
||||
cannot identify an owner, say so explicitly instead of leaving it open.
|
||||
|
||||
One line each: **owner** - the question, and why it blocks or changes the work.
|
||||
|
||||
### 3. Root Cause
|
||||
|
||||
Specific technical reason, cited as `path/to/file.ts:line`. Name the commit or PR
|
||||
that introduced it when you can find it.
|
||||
|
||||
### 4. Severity & Impact
|
||||
|
||||
Severity from the framework above, who is affected and how many, whether the
|
||||
issue is reachable by default, and the accurate workaround. If the ticket's
|
||||
stated workaround is wrong or incomplete, correct it here.
|
||||
|
||||
### 5. Implementation Scope
|
||||
|
||||
FRONTEND / BACKEND / BOTH / NODE (an n8n integration node, e.g. in
|
||||
`packages/nodes-base`, not Node.js) / INFRA (deployment, environment, or
|
||||
instance configuration), plus the exact files that would change, rough effort,
|
||||
and regression risk.
|
||||
|
||||
### 6. Suggested Approach
|
||||
|
||||
The fix shape, plus in-repo reference implementations to copy from. Short code
|
||||
sketches are welcome, full patches are not.
|
||||
|
||||
### 7. Investigation Trail
|
||||
|
||||
Commits and PRs examined, related issues, patterns found, and what you ruled out.
|
||||
Keep it to a handful of bullets, no paragraphs: this is the audit trail, not
|
||||
the argument.
|
||||
|
||||
## Formatting Rules
|
||||
|
||||
- Keep paragraphs to two or three sentences. Long prose blocks do not get read.
|
||||
- Tables only for short enumerable facts (version history, file-to-change
|
||||
mapping). Explanations belong in the surrounding prose.
|
||||
- Always cite code as `path:line` so it is clickable.
|
||||
- No recap or summary section at the end. The TL;DR already did that job.
|
||||
|
||||
## Goal
|
||||
Generate detailed investigative reports that provide complete context for immediate development handover, leveraging deep n8n ecosystem knowledge to ensure comprehensive analysis and actionable intelligence for complex workflow automation
|
||||
|
||||
Reference in New Issue
Block a user