NotificationsYou must be signed in to change notification settings
Fork4.9k
Star56.3k

feat: add summarize command for brownfield(existed) project analysis#1102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

Ray0907 wants to merge11 commits intogithub:main

base:main

Choose a base branch

fromRay0907:001-add-summarize-command

Open

feat: add summarize command for brownfield(existed) project analysis#1102

Ray0907 wants to merge11 commits intogithub:mainfromRay0907:001-add-summarize-command

Conversation

Copy link

Ray0907 commentedNov 2, 2025

Adds 'specify summarize' to analyze existing projects and generate
technology stack summaries, making it easier to onboard to unfamiliar
codebases or document project architecture.

feat: add summarize command for brownfield project analysis

4bee205

  Adds 'specify summarize' to analyze existing projects and generate  technology stack summaries, making it easier to onboard to unfamiliar  codebases or document project architecture.

Ray0907 requested a review fromlocalden as acode owner

November 2, 2025 04:43

CopilotAI review requested due to automatic review settings

November 2, 2025 04:43

CopilotAI reviewed

Nov 2, 2025

View reviewed changes

Copy link

Contributor

CopilotAI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Pull Request Overview

This PR adds a newsummarize command to analyze existing codebases and generate comprehensive project summaries. The feature helps bootstrap spec-kit usage in brownfield/existing projects by automatically discovering technology stack, architecture patterns, and code conventions.

Addedspecify summarize CLI command for project analysis
Created bash script to detect languages, frameworks, and directory structures
Added template files for project summary generation and AI assistant guidance

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
`src/specify_cli/__init__.py`	Implements`summarize` CLI command with script detection, execution, and summary generation
`scripts/bash/generate-project-summary.sh`	Bash script to detect project type, languages, config files, and directory structure
`templates/commands/summarize.md`	AI assistant template with detailed instructions for comprehensive project analysis
`templates/project-summary-template.md`	Standalone template showing expected project summary structure
`README.md`	Documentation updates for the new`summarize` command and`/speckit.summarize` slash command

💡Add Copilot custom instructions for smarter, more guided reviews.Learn how to get started.

src/specify_cli/__init__.py OutdatedShow resolvedHide resolved

templates/commands/summarize.md OutdatedShow resolvedHide resolved

templates/project-summary-template.md OutdatedShow resolvedHide resolved

src/specify_cli/__init__.py OutdatedShow resolvedHide resolved

templates/commands/summarize.md OutdatedShow resolvedHide resolved

Ray0907and others added2 commits

November 2, 2025 12:54

fix: formatting improvements for summarize command

73c7a76

Update templates/commands/summarize.md

b305d42

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

CopilotAI review requested due to automatic review settings

November 2, 2025 04:55

Update src/specify_cli/__init__.py

d88af1f

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

CopilotAI reviewed

Nov 2, 2025

View reviewed changes

Copy link

Contributor

CopilotAI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Pull Request Overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (2)

src/specify_cli/init.py:1

The fallback logic createspossible_script_names by replacing '.ps1' with '.sh', but this will only work when Windows is the platform (when script_name ends with '.ps1'). On Unix systems,script_name already ends with '.sh', so the replace operation does nothing, creating duplicate entries. Consider a more explicit approach:possible_script_names = ['generate-project-summary.sh', 'generate-project-summary.ps1'] to ensure both scripts are checked on all platforms.

#!/usr/bin/env python3

src/specify_cli/init.py:1

Thescript_type variable is set in the script search loop (lines 1222-1225), but if no script is found, the code exits at line 1234 before reaching this point. However, if somehowscript_type remains None after finding a script (e.g., if the file has an unexpected extension), this will raise an unclear error. The 'else' branch at line 1244 is unreachable given the current logic since script_type is always set when a script is found.

#!/usr/bin/env python3

💡Add Copilot custom instructions for smarter, more guided reviews.Learn how to get started.

scripts/bash/generate-project-summary.sh OutdatedShow resolvedHide resolved

templates/commands/summarize.md OutdatedShow resolvedHide resolved

Update scripts/bash/generate-project-summary.sh

c6f5ba3

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

CopilotAI review requested due to automatic review settings

November 2, 2025 05:01

Update templates/commands/summarize.md

abbda7c

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

CopilotAI reviewed

Nov 2, 2025

View reviewed changes

Copy link

Contributor

CopilotAI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Pull Request Overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

💡Add Copilot custom instructions for smarter, more guided reviews.Learn how to get started.

src/specify_cli/__init__.py OutdatedShow resolvedHide resolved

scripts/powershell/generate-project-summary.ps1 OutdatedShow resolvedHide resolved

Update src/specify_cli/__init__.py

f5bbc9c

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

CopilotAI review requested due to automatic review settings

November 2, 2025 05:05

Update scripts/powershell/generate-project-summary.ps1

38d3909

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

CopilotAI reviewed

Nov 2, 2025

View reviewed changes

Copy link

Contributor

CopilotAI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Pull Request Overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

💡Add Copilot custom instructions for smarter, more guided reviews.Learn how to get started.

src/specify_cli/__init__.py OutdatedShow resolvedHide resolved

templates/project-summary-template.md OutdatedShow resolvedHide resolved

Update src/specify_cli/__init__.py

bafc32e

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

CopilotAI review requested due to automatic review settings

November 2, 2025 05:33

Ray0907and others added2 commits

November 2, 2025 13:33

Update templates/project-summary-template.md

b5eed38

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update templates/project-summary-template.md

95306a8

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

CopilotAI reviewed

Nov 2, 2025

View reviewed changes

Copy link

Contributor

CopilotAI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Pull Request Overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

💡Add Copilot custom instructions for smarter, more guided reviews.Learn how to get started.

scripts/powershell/generate-project-summary.ps1Show resolvedHide resolved

Copy link

johnml1135 commentedNov 4, 2025

Has this been tested on anything substantial, such as +1M lines of code? In trying to manually spin summaries (sillsdev/FieldWorks#500) I found I had to do a fair amount to have copilot:

Not optimize and look at every file in a folder or project
Perform multiple passes over each folder or project so as to capture nuance
Scaffold the AI description of each project in a AI understandable format
Develop a plan for keeping the summaries up to date automatically
Keep poking the coding agent to work through the 62 major projects in the repository. It would do 10, and then quit as it said it would continue.

Feel free to look at the pull request above for inspiration. It is 2 million lines of c# and xml. I just have it drafted today I have not verified how well it works.

Labels

None yet

Movatterモバイル変換

feat: add summarize command for brownfield(existed) project analysis#1102

Are you sure you want to change the base?

feat: add summarize command for brownfield(existed) project analysis#1102

Uh oh!

Conversation

Ray0907 commentedNov 2, 2025

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

johnml1135 commentedNov 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants