Skip to content

Commit 0049b1c

Browse files
committed
Update Markdown formatting
1 parent 3e883fa commit 0049b1c

File tree

6 files changed

+25
-14
lines changed

6 files changed

+25
-14
lines changed

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -410,4 +410,4 @@ When adding new agents:
410410

411411
---
412412

413-
_This documentation should be updated whenever new agents are added to maintain accuracy and completeness._
413+
*This documentation should be updated whenever new agents are added to maintain accuracy and completeness.*

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,13 @@ To test your templates, commands, and other changes locally, follow these steps:
7171

7272
Run the following command to generate the local packages:
7373

74-
```
74+
```bash
7575
./.github/workflows/scripts/create-release-packages.sh v1.0.0
7676
```
7777

7878
2. **Copy the relevant package to your test project**
7979

80-
```
80+
```bash
8181
cp -r .genreleases/sdd-copilot-package-sh/. <path-to-test-project>/
8282
```
8383

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ Additional commands for enhanced quality and validation:
278278

279279
Spec-Driven Development is a structured process that emphasizes:
280280

281-
- **Intent-driven development** where specifications define the "_what_" before the "_how_"
281+
- **Intent-driven development** where specifications define the "*what*" before the "*how*"
282282
- **Rich specification creation** using guardrails and organizational principles
283283
- **Multi-step refinement** rather than one-shot code generation from prompts
284284
- **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
408408
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.
409409

410410
> [!IMPORTANT]
411-
> Be as explicit as possible about _what_ you are trying to build and _why_. **Do not focus on the tech stack at this point**.
411+
> Be as explicit as possible about *what* you are trying to build and *why*. **Do not focus on the tech stack at this point**.
412412
413413
An example prompt:
414414

docs/upgrade.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ specify init --here --force --ai copilot
8686

8787
Without `--force`, the CLI warns you and asks for confirmation:
8888

89-
```
89+
```text
9090
Warning: Current directory is not empty (25 items)
9191
Template files will be merged with existing content and may overwrite existing files
9292
Proceed? [y/N]
@@ -286,11 +286,13 @@ This tells Spec Kit which feature directory to use when creating specs, plans, a
286286

287287
1. **Restart your IDE/editor** completely (not just reload window)
288288
2. **For CLI-based agents**, verify files exist:
289+
289290
```bash
290291
ls -la .claude/commands/ # Claude Code
291292
ls -la .gemini/commands/ # Gemini
292293
ls -la .cursor/commands/ # Cursor
293294
```
295+
294296
3. **Check agent-specific setup:**
295297
- Codex requires `CODEX_HOME` environment variable
296298
- Some agents need workspace restart or cache clearing
@@ -312,7 +314,8 @@ cp /tmp/constitution-backup.md .specify/memory/constitution.md
312314
### "Warning: Current directory is not empty"
313315

314316
**Full warning message:**
315-
```
317+
318+
```text
316319
Warning: Current directory is not empty (25 items)
317320
Template files will be merged with existing content and may overwrite existing files
318321
Do you want to continue? [y/N]
@@ -329,6 +332,7 @@ This warning appears when you run `specify init --here` (or `specify init .`) in
329332
**What gets overwritten:**
330333

331334
Only Spec Kit infrastructure files:
335+
332336
- Agent command files (`.claude/commands/`, `.github/prompts/`, etc.)
333337
- Scripts in `.specify/scripts/`
334338
- Templates in `.specify/templates/`
@@ -346,6 +350,7 @@ Only Spec Kit infrastructure files:
346350
- **Type `y` and press Enter** - Proceed with the merge (recommended if upgrading)
347351
- **Type `n` and press Enter** - Cancel the operation
348352
- **Use `--force` flag** - Skip this confirmation entirely:
353+
349354
```bash
350355
specify init --here --force --ai copilot
351356
```
@@ -388,6 +393,7 @@ uv tool install specify-cli --from git+https://github.com/github/spec-kit.git
388393
**Explanation:**
389394

390395
The `specify` CLI tool is used for:
396+
391397
- **Initial setup:** `specify init` to bootstrap Spec Kit in your project
392398
- **Upgrades:** `specify init --here --force` to update templates and commands
393399
- **Diagnostics:** `specify check` to verify tool installation
@@ -397,6 +403,7 @@ Once you've run `specify init`, the slash commands (like `/speckit.specify`, `/s
397403
**If your agent isn't recognizing slash commands:**
398404

399405
1. **Verify command files exist:**
406+
400407
```bash
401408
# For GitHub Copilot
402409
ls -la .github/prompts/
@@ -412,6 +419,7 @@ Once you've run `specify init`, the slash commands (like `/speckit.specify`, `/s
412419
4. **For some agents**, you may need to reload the workspace or clear cache
413420

414421
**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:
422+
415423
- Restarting VS Code
416424
- Checking file permissions
417425
- Ensuring the workspace folder is properly opened

templates/commands/specify.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,27 +40,28 @@ Given that feature description, do this:
4040
- "Fix payment processing timeout bug" → "fix-payment-timeout"
4141

4242
2. **Check for existing branches before creating new one**:
43-
43+
4444
a. First, fetch all remote branches to ensure we have the latest information:
45+
4546
```bash
4647
git fetch --all --prune
4748
```
48-
49+
4950
b. Find the highest feature number across all sources for the short-name:
5051
- Remote branches: `git ls-remote --heads origin | grep -E 'refs/heads/[0-9]+-<short-name>$'`
5152
- Local branches: `git branch | grep -E '^[* ]*[0-9]+-<short-name>$'`
5253
- Specs directories: Check for directories matching `specs/[0-9]+-<short-name>`
53-
54+
5455
c. Determine the next available number:
5556
- Extract all numbers from all three sources
5657
- Find the highest number N
5758
- Use N+1 for the new branch number
58-
59+
5960
d. Run the script `{SCRIPT}` with the calculated number and short-name:
6061
- Pass `--number N+1` and `--short-name "your-short-name"` along with the feature description
6162
- Bash example: `{SCRIPT} --json --number 5 --short-name "user-auth" "Add user authentication"`
6263
- PowerShell example: `{SCRIPT} -Json -Number 5 -ShortName "user-auth" "Add user authentication"`
63-
64+
6465
**IMPORTANT**:
6566
- Check all three sources (remote branches, local branches, specs directories) to find the highest number
6667
- Only match branches/directories with the exact short-name pattern

templates/commands/taskstoissues.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ You **MUST** consider the user input before proceeding (if not empty).
2424
git config --get remote.origin.url
2525
```
2626

27-
**ONLY PROCEED TO NEXT STEPS IF THE REMOTE IS A GITHUB URL**
27+
> [!CAUTION]
28+
> ONLY PROCEED TO NEXT STEPS IF THE REMOTE IS A GITHUB URL
2829
2930
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.
3031

31-
**UNDER NO CIRCUMSTANCES EVER CREATE ISSUES IN REPOSITORIES THAT DO NOT MATCH THE REMOTE URL**
32+
> [!CAUTION]
33+
> UNDER NO CIRCUMSTANCES EVER CREATE ISSUES IN REPOSITORIES THAT DO NOT MATCH THE REMOTE URL

0 commit comments

Comments
 (0)