mirror of
https://github.com/github/awesome-copilot.git
synced 2026-04-15 20:55:55 +00:00
* feat(skill): add acquire-codebase-knowledge skill documentation * feat(templates): add architecture, concerns, conventions, integrations, stack, structure, and testing documentation templates * feat(references): add inquiry checkpoints and stack detection documentation * feat(scan): add script to collect project discovery information for acquire-codebase-knowledge skill * feat(skills): add acquire-codebase-knowledge skill for codebase mapping and documentation * feat(scan): enhance scan script with absolute path handling and improved output variable validation * feat(scan): replace bash script with Python script for project discovery information collection * feat(skills): update acquire-codebase-knowledge skill to replace scan.sh with scan.py
57 lines
1.7 KiB
Markdown
57 lines
1.7 KiB
Markdown
# Codebase Concerns
|
|
|
|
## Core Sections (Required)
|
|
|
|
### 1) Top Risks (Prioritized)
|
|
|
|
| Severity | Concern | Evidence | Impact | Suggested action |
|
|
|----------|---------|----------|--------|------------------|
|
|
| [high/med/low] | [issue] | [file or scan output] | [impact] | [next action] |
|
|
|
|
### 2) Technical Debt
|
|
|
|
List the most important debt items only.
|
|
|
|
| Debt item | Why it exists | Where | Risk if ignored | Suggested fix |
|
|
|-----------|---------------|-------|-----------------|---------------|
|
|
| [item] | [reason] | [path] | [risk] | [fix] |
|
|
|
|
### 3) Security Concerns
|
|
|
|
| Risk | OWASP category (if applicable) | Evidence | Current mitigation | Gap |
|
|
|------|--------------------------------|----------|--------------------|-----|
|
|
| [risk] | [A01/A03/etc or N/A] | [path] | [what exists] | [what is missing] |
|
|
|
|
### 4) Performance and Scaling Concerns
|
|
|
|
| Concern | Evidence | Current symptom | Scaling risk | Suggested improvement |
|
|
|---------|----------|-----------------|-------------|-----------------------|
|
|
| [issue] | [path/metric] | [symptom] | [risk] | [action] |
|
|
|
|
### 5) Fragile/High-Churn Areas
|
|
|
|
| Area | Why fragile | Churn signal | Safe change strategy |
|
|
|------|-------------|-------------|----------------------|
|
|
| [path] | [reason] | [recent churn evidence] | [approach] |
|
|
|
|
### 6) `[ASK USER]` Questions
|
|
|
|
Add unresolved intent-dependent questions as a numbered list.
|
|
|
|
1. [ASK USER] [question]
|
|
|
|
### 7) Evidence
|
|
|
|
- [scan output section reference]
|
|
- [path/to/code-file]
|
|
- [path/to/config-or-history-evidence]
|
|
|
|
## Extended Sections (Optional)
|
|
|
|
Add only when needed:
|
|
|
|
- Full bug inventory
|
|
- Component-level remediation roadmap
|
|
- Cost/effort estimates by concern
|
|
- Dependency-risk and ownership mapping
|