Skip to content

Commit 65f8787

Browse files
committed
Merge branch 'localden/vscode' of https://github.com/github/spec-kit into localden/vscode
2 parents 9786e58 + 0ac76c8 commit 65f8787

13 files changed

Lines changed: 81 additions & 38 deletions

.github/workflows/lint.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Lint
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
pull_request:
7+
8+
jobs:
9+
markdownlint:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v4
14+
15+
- name: Run markdownlint-cli2
16+
uses: DavidAnson/markdownlint-cli2-action@v19
17+
with:
18+
globs: '**/*.md'

.markdownlint-cli2.jsonc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
// https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
3+
"config": {
4+
"default": true,
5+
"MD003": {
6+
"style": "atx"
7+
},
8+
"MD007": {
9+
"indent": 2
10+
},
11+
"MD013": false,
12+
"MD024": {
13+
"siblings_only": true
14+
},
15+
"MD033": false,
16+
"MD041": false,
17+
"MD049": {
18+
"style": "asterisk"
19+
},
20+
"MD050": {
21+
"style": "asterisk"
22+
}
23+
}
24+
}

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6363

6464
- New `/clarify` command template to surface up to 5 targeted clarification questions for an existing spec and persist answers into a Clarifications section in the spec.
6565
- New `/analyze` command template providing a non-destructive cross-artifact discrepancy and alignment report (spec, clarifications, plan, tasks, constitution) inserted after `/tasks` and before `/implement`.
66-
- Note: Constitution rules are explicitly treated as non-negotiable; any conflict is a CRITICAL finding requiring artifact remediation, not weakening of principles.
66+
- Note: Constitution rules are explicitly treated as non-negotiable; any conflict is a CRITICAL finding requiring artifact remediation, not weakening of principles.
6767

6868
## [0.0.16] - 2025-09-22
6969

CODE_OF_CONDUCT.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ orientation.
1414
Examples of behavior that contributes to creating a positive environment
1515
include:
1616

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
2222

2323
Examples of unacceptable behavior by participants include:
2424

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
2626
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
3030
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
31+
- Other conduct which could reasonably be considered inappropriate in a
3232
professional setting
3333

3434
## Our Responsibilities

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Contributing to Spec Kit
1+
# Contributing to Spec Kit
22

33
Hi there! We're thrilled that you'd like to contribute to Spec Kit. Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
44

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<img src="./media/logo_small.webp"/>
2+
<img src="./media/logo_small.webp" alt="Spec Kit Logo"/>
33
<h1>🌱 Spec Kit</h1>
44
<h3><em>Build high-quality software faster.</em></h3>
55
</div>
@@ -253,7 +253,7 @@ Additional commands for enhanced quality and validation:
253253

254254
Spec-Driven Development is a structured process that emphasizes:
255255

256-
- **Intent-driven development** where specifications define the "_what_" before the "_how_"
256+
- **Intent-driven development** where specifications define the "*what*" before the "*how*"
257257
- **Rich specification creation** using guardrails and organizational principles
258258
- **Multi-step refinement** rather than one-shot code generation from prompts
259259
- **Heavy reliance** on advanced AI model capabilities for specification interpretation
@@ -383,7 +383,7 @@ This step creates or updates the `.specify/memory/constitution.md` file with you
383383
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.
384384

385385
>[!IMPORTANT]
386-
>Be as explicit as possible about _what_ you are trying to build and _why_. **Do not focus on the tech stack at this point**.
386+
>Be as explicit as possible about *what* you are trying to build and *why*. **Do not focus on the tech stack at this point**.
387387
388388
An example prompt:
389389

SECURITY.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Thanks for helping make GitHub safe for everyone.
1+
# Security Policy
22

3-
# Security
3+
Thanks for helping make GitHub safe for everyone.
44

55
GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as [GitHub](https://github.com/GitHub).
66

@@ -16,13 +16,13 @@ Instead, please send an email to opensource-security[@]github.com.
1616

1717
Please include as much of the information listed below as you can to help us better understand and resolve the issue:
1818

19-
* The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
20-
* Full paths of source file(s) related to the manifestation of the issue
21-
* The location of the affected source code (tag/branch/commit or direct URL)
22-
* Any special configuration required to reproduce the issue
23-
* Step-by-step instructions to reproduce the issue
24-
* Proof-of-concept or exploit code (if possible)
25-
* Impact of the issue, including how an attacker might exploit the issue
19+
- The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
20+
- Full paths of source file(s) related to the manifestation of the issue
21+
- The location of the affected source code (tag/branch/commit or direct URL)
22+
- Any special configuration required to reproduce the issue
23+
- Step-by-step instructions to reproduce the issue
24+
- Proof-of-concept or exploit code (if possible)
25+
- Impact of the issue, including how an attacker might exploit the issue
2626

2727
This information will help us triage your report more quickly.
2828

templates/agent-file-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Auto-generated from all feature plans. Last updated: [DATE]
88

99
## Project Structure
1010

11-
```
11+
```text
1212
[ACTUAL STRUCTURE FROM PLANS]
1313
```
1414

templates/commands/clarify.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,11 @@ Execution steps:
9393
- Each question must be answerable with EITHER:
9494
- A short multiple‑choice selection (2–5 distinct, mutually exclusive options), OR
9595
- A one-word / short‑phrase answer (explicitly constrain: "Answer in <=5 words").
96-
- Only include questions whose answers materially impact architecture, data modeling, task decomposition, test design, UX behavior, operational readiness, or compliance validation.
97-
- Ensure category coverage balance: attempt to cover the highest impact unresolved categories first; avoid asking two low-impact questions when a single high-impact area (e.g., security posture) is unresolved.
98-
- Exclude questions already answered, trivial stylistic preferences, or plan-level execution details (unless blocking correctness).
99-
- Favor clarifications that reduce downstream rework risk or prevent misaligned acceptance tests.
100-
- If more than 5 categories remain unresolved, select the top 5 by (Impact * Uncertainty) heuristic.
96+
- Only include questions whose answers materially impact architecture, data modeling, task decomposition, test design, UX behavior, operational readiness, or compliance validation.
97+
- Ensure category coverage balance: attempt to cover the highest impact unresolved categories first; avoid asking two low-impact questions when a single high-impact area (e.g., security posture) is unresolved.
98+
- Exclude questions already answered, trivial stylistic preferences, or plan-level execution details (unless blocking correctness).
99+
- Favor clarifications that reduce downstream rework risk or prevent misaligned acceptance tests.
100+
- If more than 5 categories remain unresolved, select the top 5 by (Impact * Uncertainty) heuristic.
101101

102102
4. Sequential questioning loop (interactive):
103103
- Present EXACTLY ONE question at a time.
@@ -115,8 +115,8 @@ Execution steps:
115115
|--------|-------------|
116116
| A | <Option A description> |
117117
| B | <Option B description> |
118-
| C | <Option C description> | (add D/E as needed up to 5)
119-
| Short | Provide a different short answer (<=5 words) | (Include only if free-form alternative is appropriate)
118+
| C | <Option C description> (add D/E as needed up to 5) |
119+
| Short | Provide a different short answer (<=5 words) (Include only if free-form alternative is appropriate) |
120120

121121
- After the table, add: `You can reply with the option letter (e.g., "A"), accept the recommendation by saying "yes" or "recommended", or provide your own short answer.`
122122
- For short‑answer style (no meaningful discrete options):

templates/commands/implement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ You **MUST** consider the user input before proceeding (if not empty).
2525
- Incomplete items: Lines matching `- [ ]`
2626
- Create a status table:
2727

28-
```
28+
```text
2929
| Checklist | Total | Completed | Incomplete | Status |
3030
|-----------|-------|-----------|------------|--------|
3131
| ux.md | 12 | 12 | 0 | ✓ PASS |

0 commit comments

Comments
 (0)