Skip to content

docs(assess): clarify the pipeline works on an empty project#3732

Open
mnriem wants to merge 2 commits into
github:mainfrom
mnriem:mnriem-docs-assess-empty-project
Open

docs(assess): clarify the pipeline works on an empty project#3732
mnriem wants to merge 2 commits into
github:mainfrom
mnriem:mnriem-docs-assess-empty-project

Conversation

@mnriem

@mnriem mnriem commented Jul 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

Makes it explicit that the assess extension can be used on an empty, freshly initialized project — no existing source code is required. An empty project and an existing codebase are equally valid starting points.

Previously the docs only implied this, and the "codebase pointer" / "assess this repo" wording in intake could give the impression that existing code was expected. This adds two short, explicit statements.

Changes

  • extensions/assess/README.md — Overview now states that assess works equally well on an empty project or an existing codebase; the input is just an idea (pasted text, a URL, a ticket, or a codebase pointer).
  • extensions/assess/commands/speckit.assess.intake.md — adds a line after the input-types list clarifying there is no requirement for existing source code, and that both starting points are equally valid.

Docs-only change; no behavior or code affected.


🤖 This PR was authored autonomously by GitHub Copilot (model: Claude Opus 4.8) on behalf of @mnriem.

Copilot AI review requested due to automatic review settings July 24, 2026 21:03
@mnriem
mnriem force-pushed the mnriem-docs-assess-empty-project branch from f93737d to bc68151 Compare July 24, 2026 21:04
State explicitly in the README and intake command that the assess
pipeline requires no existing source code. An empty, freshly
initialized project and an existing codebase are equally valid
starting points — the input is just an idea (pasted text, a URL, a
ticket, or a codebase pointer).

Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9df2615e-6a99-4cdc-b4b2-fc72029bc1d9
@mnriem
mnriem force-pushed the mnriem-docs-assess-empty-project branch from bc68151 to 68619ff Compare July 24, 2026 21:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Clarifies that the assessment pipeline supports freshly initialized projects without source code.

Changes:

  • Documents empty-project support in the extension overview.
  • Clarifies valid intake inputs and starting points.
Show a summary per file
File Description
extensions/assess/README.md Explains empty and existing projects are supported.
extensions/assess/commands/speckit.assess.intake.md Clarifies intake does not require source code.

Review details

Tip

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

  • Files reviewed: 2/2 changed files
  • Comments generated: 0
  • Review effort level: Medium

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review details

  • Files reviewed: 2/2 changed files
  • Comments generated: 2
  • Review effort level: Medium

Comment thread extensions/assess/README.md Outdated

## Overview

`assess` works equally well for a **freshly initialized, empty project** or for an **existing codebase** — you do not need any source code to assess an idea. The input is just an idea: pasted text, a URL, or a ticket work with no repo at all, and a codebase pointer lets you assess an idea for existing code. Neither is more "correct" than the other.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Good catch — reworded to make clear this runs inside an initialized Spec Kit project (it writes under .specify/assessments/); only existing source code is optional. Fixed in 70fc8b1. — GitHub Copilot (model: Claude Opus 4.8), on behalf of @mnriem

3. **A codebase pointer** — phrasing like "an idea for this repo" or a path. Read enough of the repository to record what the idea relates to.
4. **A mix** of the above.

There is **no requirement for existing source code**: intake works just as well for an empty, freshly initialized project as for an existing codebase. Pasted text or a URL (options 1–2) need no repo; a codebase pointer (option 3) targets existing code. Both are equally valid.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Agreed — narrowed "need no repo" to "need no existing codebase" and scoped the sentence to an initialized Spec Kit project. Fixed in 70fc8b1. — GitHub Copilot (model: Claude Opus 4.8), on behalf of @mnriem

Clarify that assess still runs inside an initialized Spec Kit project
(writing under .specify/assessments/) — only existing source code is
optional. Reword 'no repo at all'/'need no repo' to 'need no existing
codebase' so users don't expect intake to work outside a Spec Kit
project.

Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9df2615e-6a99-4cdc-b4b2-fc72029bc1d9
Copilot AI review requested due to automatic review settings July 24, 2026 21:13
@mnriem

mnriem commented Jul 24, 2026

Copy link
Copy Markdown
Collaborator Author

Addressed the review feedback in 70fc8b1.

Both comments flagged the same overstatement — "no repo at all" / "need no repo" — which wrongly implied intake works outside a Spec Kit project. Fixed by:

  • README — now states assess runs inside an initialized Spec Kit project (writing under .specify/assessments/), and that the project can be empty of source code; only existing code is optional.
  • intake.md — narrowed "need no repo" to "need no existing codebase" and scoped the sentence to an initialized Spec Kit project.

— GitHub Copilot (model: Claude Opus 4.8), acting autonomously on behalf of @mnriem

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review details

  • Files reviewed: 2/2 changed files
  • Comments generated: 0 new
  • Review effort level: Medium

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants