-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Created spec for issue #2165 #2196
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
+51
−0
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
51 changes: 51 additions & 0 deletions
51
.specify/features/git-extension-deprecation-notice/spec.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Add notice that git extension will no longer be enabled by default at 1.0.0 | ||
|
|
||
| > **Source**: [#2165](https://github.com/github/spec-kit/issues/2165) — imported on 2026-04-12 | ||
|
|
||
| ## Overview | ||
|
|
||
| Add a deprecation notice during `specify init` to inform users that the git extension, currently auto-enabled by default, will require explicit opt-in starting with v1.0.0. This ensures users are aware of the upcoming behavioral change well in advance. | ||
|
|
||
| ## Problem Statement | ||
|
|
||
| The `git` extension is currently bundled and enabled by default during `specify init`. Starting with v1.0.0, it will still be bundled but no longer enabled by default — users will need to explicitly opt in. Without advance notice, users may be surprised by this change when upgrading to v1.0.0. | ||
|
|
||
| ## Requirements | ||
|
|
||
| ### Functional Requirements | ||
|
|
||
| - FR-1: During `specify init`, display a warning notice when the git extension is auto-enabled | ||
| - FR-2: The notice must clearly state the timeline (v1.0.0) for the change | ||
| - FR-3: The notice must explain how to opt in after the change (`specify init --extension git` or `specify extension add git`) | ||
| - FR-4: The notice must be non-blocking (warning styling, does not halt initialization) | ||
aaronrsun marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Non-Functional Requirements | ||
|
|
||
| - NFR-1: Notice should use yellow/warning styling consistent with existing CLI warning patterns | ||
| - NFR-2: Notice should be concise and actionable | ||
|
|
||
| ## User Scenarios | ||
|
|
||
| ### Scenario 1: User runs specify init and sees deprecation notice | ||
|
|
||
| **Given** a user is initializing a new project with `specify init` | ||
| **When** the git extension is auto-enabled as part of the default behavior | ||
| **Then** a warning notice is displayed informing them that the git extension will require explicit opt-in starting with v1.0.0 | ||
|
|
||
| ### Scenario 2: User understands how to opt in after v1.0.0 | ||
|
|
||
| **Given** a user sees the deprecation notice during `specify init` | ||
| **When** they read the notice | ||
| **Then** they understand they can use `specify init --extension git` or `specify extension add git` to enable the git extension after v1.0.0 | ||
|
|
||
aaronrsun marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Acceptance Criteria | ||
|
|
||
| - [ ] AC-1: `specify init` shows a notice when the git extension is auto-enabled | ||
| - [ ] AC-2: Notice is visible but non-blocking (yellow/warning styling) | ||
| - [ ] AC-3: Message clearly states the timeline (v1.0.0) and how to opt in | ||
|
|
||
| ## Out of Scope | ||
|
|
||
| - Changes to the git extension itself or its functionality | ||
| - Changes to the bundled status of the git extension (it remains bundled/shipped with spec-kit) | ||
| - Actually removing the default-enabled behavior (that happens at v1.0.0, not now) | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.