Update Markdown formatting

This commit is contained in:
den (work)
2025-12-04 11:55:56 -08:00
parent 3e883fa32c
commit 0049b1cdc2
6 changed files with 25 additions and 14 deletions

View File

@@ -410,4 +410,4 @@ When adding new agents:
--- ---
_This documentation should be updated whenever new agents are added to maintain accuracy and completeness._ *This documentation should be updated whenever new agents are added to maintain accuracy and completeness.*

View File

@@ -71,13 +71,13 @@ To test your templates, commands, and other changes locally, follow these steps:
Run the following command to generate the local packages: Run the following command to generate the local packages:
``` ```bash
./.github/workflows/scripts/create-release-packages.sh v1.0.0 ./.github/workflows/scripts/create-release-packages.sh v1.0.0
``` ```
2. **Copy the relevant package to your test project** 2. **Copy the relevant package to your test project**
``` ```bash
cp -r .genreleases/sdd-copilot-package-sh/. <path-to-test-project>/ cp -r .genreleases/sdd-copilot-package-sh/. <path-to-test-project>/
``` ```

View File

@@ -278,7 +278,7 @@ Additional commands for enhanced quality and validation:
Spec-Driven Development is a structured process that emphasizes: Spec-Driven Development is a structured process that emphasizes:
- **Intent-driven development** where specifications define the "_what_" before the "_how_" - **Intent-driven development** where specifications define the "*what*" before the "*how*"
- **Rich specification creation** using guardrails and organizational principles - **Rich specification creation** using guardrails and organizational principles
- **Multi-step refinement** rather than one-shot code generation from prompts - **Multi-step refinement** rather than one-shot code generation from prompts
- **Heavy reliance** on advanced AI model capabilities for specification interpretation - **Heavy reliance** on advanced AI model capabilities for specification interpretation
@@ -408,7 +408,7 @@ This step creates or updates the `.specify/memory/constitution.md` file with you
With your project principles established, you can now create the functional specifications. Use the `/speckit.specify` command and then provide the concrete requirements for the project you want to develop. With your project principles established, you can now create the functional specifications. Use the `/speckit.specify` command and then provide the concrete requirements for the project you want to develop.
> [!IMPORTANT] > [!IMPORTANT]
> Be as explicit as possible about _what_ you are trying to build and _why_. **Do not focus on the tech stack at this point**. > Be as explicit as possible about *what* you are trying to build and *why*. **Do not focus on the tech stack at this point**.
An example prompt: An example prompt:

View File

@@ -86,7 +86,7 @@ specify init --here --force --ai copilot
Without `--force`, the CLI warns you and asks for confirmation: Without `--force`, the CLI warns you and asks for confirmation:
``` ```text
Warning: Current directory is not empty (25 items) Warning: Current directory is not empty (25 items)
Template files will be merged with existing content and may overwrite existing files Template files will be merged with existing content and may overwrite existing files
Proceed? [y/N] Proceed? [y/N]
@@ -286,11 +286,13 @@ This tells Spec Kit which feature directory to use when creating specs, plans, a
1. **Restart your IDE/editor** completely (not just reload window) 1. **Restart your IDE/editor** completely (not just reload window)
2. **For CLI-based agents**, verify files exist: 2. **For CLI-based agents**, verify files exist:
```bash ```bash
ls -la .claude/commands/ # Claude Code ls -la .claude/commands/ # Claude Code
ls -la .gemini/commands/ # Gemini ls -la .gemini/commands/ # Gemini
ls -la .cursor/commands/ # Cursor ls -la .cursor/commands/ # Cursor
``` ```
3. **Check agent-specific setup:** 3. **Check agent-specific setup:**
- Codex requires `CODEX_HOME` environment variable - Codex requires `CODEX_HOME` environment variable
- Some agents need workspace restart or cache clearing - Some agents need workspace restart or cache clearing
@@ -312,7 +314,8 @@ cp /tmp/constitution-backup.md .specify/memory/constitution.md
### "Warning: Current directory is not empty" ### "Warning: Current directory is not empty"
**Full warning message:** **Full warning message:**
```
```text
Warning: Current directory is not empty (25 items) Warning: Current directory is not empty (25 items)
Template files will be merged with existing content and may overwrite existing files Template files will be merged with existing content and may overwrite existing files
Do you want to continue? [y/N] Do you want to continue? [y/N]
@@ -329,6 +332,7 @@ This warning appears when you run `specify init --here` (or `specify init .`) in
**What gets overwritten:** **What gets overwritten:**
Only Spec Kit infrastructure files: Only Spec Kit infrastructure files:
- Agent command files (`.claude/commands/`, `.github/prompts/`, etc.) - Agent command files (`.claude/commands/`, `.github/prompts/`, etc.)
- Scripts in `.specify/scripts/` - Scripts in `.specify/scripts/`
- Templates in `.specify/templates/` - Templates in `.specify/templates/`
@@ -346,6 +350,7 @@ Only Spec Kit infrastructure files:
- **Type `y` and press Enter** - Proceed with the merge (recommended if upgrading) - **Type `y` and press Enter** - Proceed with the merge (recommended if upgrading)
- **Type `n` and press Enter** - Cancel the operation - **Type `n` and press Enter** - Cancel the operation
- **Use `--force` flag** - Skip this confirmation entirely: - **Use `--force` flag** - Skip this confirmation entirely:
```bash ```bash
specify init --here --force --ai copilot specify init --here --force --ai copilot
``` ```
@@ -388,6 +393,7 @@ uv tool install specify-cli --from git+https://github.com/github/spec-kit.git
**Explanation:** **Explanation:**
The `specify` CLI tool is used for: The `specify` CLI tool is used for:
- **Initial setup:** `specify init` to bootstrap Spec Kit in your project - **Initial setup:** `specify init` to bootstrap Spec Kit in your project
- **Upgrades:** `specify init --here --force` to update templates and commands - **Upgrades:** `specify init --here --force` to update templates and commands
- **Diagnostics:** `specify check` to verify tool installation - **Diagnostics:** `specify check` to verify tool installation
@@ -397,6 +403,7 @@ Once you've run `specify init`, the slash commands (like `/speckit.specify`, `/s
**If your agent isn't recognizing slash commands:** **If your agent isn't recognizing slash commands:**
1. **Verify command files exist:** 1. **Verify command files exist:**
```bash ```bash
# For GitHub Copilot # For GitHub Copilot
ls -la .github/prompts/ ls -la .github/prompts/
@@ -412,6 +419,7 @@ Once you've run `specify init`, the slash commands (like `/speckit.specify`, `/s
4. **For some agents**, you may need to reload the workspace or clear cache 4. **For some agents**, you may need to reload the workspace or clear cache
**Related issue:** If Copilot can't open local files or uses PowerShell commands unexpectedly, this is typically an IDE context issue, not related to `specify`. Try: **Related issue:** If Copilot can't open local files or uses PowerShell commands unexpectedly, this is typically an IDE context issue, not related to `specify`. Try:
- Restarting VS Code - Restarting VS Code
- Checking file permissions - Checking file permissions
- Ensuring the workspace folder is properly opened - Ensuring the workspace folder is properly opened

View File

@@ -40,27 +40,28 @@ Given that feature description, do this:
- "Fix payment processing timeout bug" → "fix-payment-timeout" - "Fix payment processing timeout bug" → "fix-payment-timeout"
2. **Check for existing branches before creating new one**: 2. **Check for existing branches before creating new one**:
a. First, fetch all remote branches to ensure we have the latest information: a. First, fetch all remote branches to ensure we have the latest information:
```bash ```bash
git fetch --all --prune git fetch --all --prune
``` ```
b. Find the highest feature number across all sources for the short-name: b. Find the highest feature number across all sources for the short-name:
- Remote branches: `git ls-remote --heads origin | grep -E 'refs/heads/[0-9]+-<short-name>$'` - Remote branches: `git ls-remote --heads origin | grep -E 'refs/heads/[0-9]+-<short-name>$'`
- Local branches: `git branch | grep -E '^[* ]*[0-9]+-<short-name>$'` - Local branches: `git branch | grep -E '^[* ]*[0-9]+-<short-name>$'`
- Specs directories: Check for directories matching `specs/[0-9]+-<short-name>` - Specs directories: Check for directories matching `specs/[0-9]+-<short-name>`
c. Determine the next available number: c. Determine the next available number:
- Extract all numbers from all three sources - Extract all numbers from all three sources
- Find the highest number N - Find the highest number N
- Use N+1 for the new branch number - Use N+1 for the new branch number
d. Run the script `{SCRIPT}` with the calculated number and short-name: d. Run the script `{SCRIPT}` with the calculated number and short-name:
- Pass `--number N+1` and `--short-name "your-short-name"` along with the feature description - Pass `--number N+1` and `--short-name "your-short-name"` along with the feature description
- Bash example: `{SCRIPT} --json --number 5 --short-name "user-auth" "Add user authentication"` - Bash example: `{SCRIPT} --json --number 5 --short-name "user-auth" "Add user authentication"`
- PowerShell example: `{SCRIPT} -Json -Number 5 -ShortName "user-auth" "Add user authentication"` - PowerShell example: `{SCRIPT} -Json -Number 5 -ShortName "user-auth" "Add user authentication"`
**IMPORTANT**: **IMPORTANT**:
- Check all three sources (remote branches, local branches, specs directories) to find the highest number - Check all three sources (remote branches, local branches, specs directories) to find the highest number
- Only match branches/directories with the exact short-name pattern - Only match branches/directories with the exact short-name pattern

View File

@@ -24,8 +24,10 @@ You **MUST** consider the user input before proceeding (if not empty).
git config --get remote.origin.url git config --get remote.origin.url
``` ```
**ONLY PROCEED TO NEXT STEPS IF THE REMOTE IS A GITHUB URL** > [!CAUTION]
> ONLY PROCEED TO NEXT STEPS IF THE REMOTE IS A GITHUB URL
1. For each task in the list, use the GitHub MCP server to create a new issue in the repository that is representative of the Git remote. 1. For each task in the list, use the GitHub MCP server to create a new issue in the repository that is representative of the Git remote.
**UNDER NO CIRCUMSTANCES EVER CREATE ISSUES IN REPOSITORIES THAT DO NOT MATCH THE REMOTE URL** > [!CAUTION]
> UNDER NO CIRCUMSTANCES EVER CREATE ISSUES IN REPOSITORIES THAT DO NOT MATCH THE REMOTE URL