Adds a new Agent Skill - Acquire-Codebase-Knowledge#1373
Open
SriSatyaLokesh wants to merge 6 commits intogithub:stagedfrom
Open
Adds a new Agent Skill - Acquire-Codebase-Knowledge#1373SriSatyaLokesh wants to merge 6 commits intogithub:stagedfrom
SriSatyaLokesh wants to merge 6 commits intogithub:stagedfrom
Conversation
…s, stack, structure, and testing documentation templates
…cquire-codebase-knowledge skill
…ng and documentation
Contributor
🔍 Skill Validator Results2 resource(s) checked | ✅ All checks passed Full output
|
Contributor
Author
This skill follows the https://agentskills.io/skill-creation/best-practices and having 1+ direcortory deep is valid to keep templates in assets keeping the skill clutter free |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Agent Skill (acquire-codebase-knowledge) intended to help users systematically scan and document an unfamiliar repository into a consistent docs/codebase/ document set, using bundled templates, references, and a scanning script.
Changes:
- Introduces the
acquire-codebase-knowledgeskill with a 4-phase workflow and an explicit output contract. - Adds a bundled Bash scanning script plus reference checklists/heuristics and seven documentation templates.
- Registers the new skill in
docs/README.skills.md.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/acquire-codebase-knowledge/SKILL.md | Defines the skill’s workflow, output contract, and how to use bundled assets. |
| skills/acquire-codebase-knowledge/scripts/scan.sh | Adds a repo discovery script producing a single scan artefact (tree, manifests, TODOs, git history, churn, monorepo signals). |
| skills/acquire-codebase-knowledge/references/inquiry-checkpoints.md | Provides per-template investigation questions used during Phase 2. |
| skills/acquire-codebase-knowledge/references/stack-detection.md | Adds stack/manifest/framework detection heuristics for ambiguous repos. |
| skills/acquire-codebase-knowledge/assets/templates/*.md | Adds seven templates for codebase documentation outputs. |
| docs/README.skills.md | Adds the new skill to the published skills index. |
Comment on lines
+66
to
+74
| # --- Redirect stdout to file if requested --- | ||
| if [[ -n "$OUTPUT_FILE" ]]; then | ||
| output_dir="$(dirname "$OUTPUT_FILE")" | ||
| if [[ "$output_dir" != "." ]]; then | ||
| mkdir -p "$output_dir" | ||
| fi | ||
| exec > "$OUTPUT_FILE" | ||
| echo "Writing output to: $OUTPUT_FILE" >&2 | ||
| fi |
There was a problem hiding this comment.
When --output is used, stdout is redirected to the output file before the directory tree is generated. That means the subsequent find will typically include the output file itself (e.g., docs/codebase/.codebase-scan.txt) in the tree/TODO scans, creating self-referential noise. Consider excluding $OUTPUT_FILE (or its directory) from find/grep inputs once it’s created.
Contributor
Author
There was a problem hiding this comment.
@copilot apply changes based on this feedback
…ved output variable validation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.stagedbranch for this pull request.Description
Adds a new Agent Skill —
acquire-codebase-knowledge— that systematically maps and documents an unfamiliar codebase into seven structured documents underdocs/codebase/. The skill runs a four-phase workflow: scan the repo, investigate each documentation area, populate templates, then validate and present findings with explicit[ASK USER]gaps rather than guessing.Bundled assets:
scripts/scan.shreferences/inquiry-checkpoints.mdreferences/stack-detection.mdassets/templates/STACK.mdassets/templates/STRUCTURE.mdassets/templates/ARCHITECTURE.mdassets/templates/CONVENTIONS.mdassets/templates/INTEGRATIONS.mdassets/templates/TESTING.mdassets/templates/CONCERNS.mdUsage: Install the skill folder and invoke via
/Acquire Codebase Knowledgein Copilot Chat in VS code or CLI. Optionally pass a focus area (e.g.architecture only) to scope Phase 2 and 3 while still running the full Phase 1 scan.Type of Contribution
Additional Notes
bash/git/find) with a PowerShell fallback documented inSKILL.mdfor Windows-without-Bash environments.acquire-codebase-knowledge.prompt.mdcompanion prompt can be added inprompts/but our repo currently doesn't support companian prompts yetnpm run skill:validateandnpm run buildpasses with exit code 0.