Skip to content

Commit c2c90a3

Browse files
📝[Docs]: Correct Markdown casing and improve clarity in documentation files
1 parent a1d2168 commit c2c90a3

File tree

4 files changed

+20
-16
lines changed

4 files changed

+20
-16
lines changed

‎.github/instructions/md.instructions.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Markdown style guidelines for consistency across documentation.
55

66
# Markdown Style Guidelines
77

8-
This document defines the markdown style guidelines for all markdown files in this repository. These rules follow common markdown linter best practices and ensure consistency across documentation.
8+
This document defines the Markdown style guidelines for all Markdown files in this repository. These rules follow common markdown linter best practices and ensure consistency across documentation.
99

1010
## Headings
1111

@@ -110,7 +110,7 @@ No blank lines before/after code blocks.
110110
- Always provide link text in square brackets: `[text](url)`
111111
- Do not use bare URLs (wrap them: `<https://example.com>`)
112112
- For internal repository links, use relative paths starting with `./` or `../`
113-
- Use `.md` extension for links to markdown files
113+
- Use `.md` extension for links to Markdown files
114114

115115
**Good:**
116116

‎.github/instructions/pwsh.instructions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -629,7 +629,7 @@ Get-ChildItem -Path 'C:\Temp' -Filter '*.txt' -Recurse $true -ErrorAction 'Stop'
629629

630630
- Use PowerShell comparison operators (`-eq`, `-ne`, `-gt`, `-lt`, `-ge`, `-le`)
631631
- Don't use C-style operators (`==`, `!=`, `>`, `<`)
632-
- Use `-like` for wildcard matching, `-match` for regex
632+
- Use `-like` for wildcard matching, `-match` for regular expression
633633
- Use `-contains` for collection membership, not `-eq`
634634
- Add `-i` prefix for case-insensitive (default) or `-c` for case-sensitive
635635
- Caution with $null comparisons. Comparison order is important depending if the variable is a single item or a collection.

‎.github/prompts/constitution.prompt.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,12 @@ Follow this execution flow:
6464

6565
3. Draft / Merge updated constitution content:
6666
- In Iteration Mode, integrate new principles/sections with minimal disruption:
67-
* Retain stable identifiers (e.g., keep existing principle numbering unless renumbering is explicitly required or gaps introduced by removals).
68-
* When replacing, either (a) fully substitute content if user confirmed or (b) append revised content and mark old with `DEPRECATED:` prefix plus TODO for removal in a future major version.
69-
- Replace every placeholder with concrete text (no bracketed tokens left except intentionally retained template slots that the project has chosen not to define yet—explicitly justify any left).
70-
- Preserve heading hierarchy and comments can be removed once replaced unless they still add clarifying guidance.
71-
- Ensure each Principle section: succinct name line, paragraph (or bullet list) capturing non‑negotiable rules, explicit rationale if not obvious.
72-
- Ensure Governance section lists amendment procedure, versioning policy, and compliance review expectations.
67+
* Retain stable identifiers (e.g., keep existing principle numbering unless renumbering is explicitly required or gaps introduced by removals).
68+
* When replacing, either (a) fully substitute content if user confirmed or (b) append revised content and mark old with `DEPRECATED:` prefix plus TODO for removal in a future major version.
69+
- Replace every placeholder with concrete text (no bracketed tokens left except intentionally retained template slots that the project has chosen not to define yet—explicitly justify any left).
70+
- Preserve heading hierarchy and comments can be removed once replaced unless they still add clarifying guidance.
71+
- Ensure each Principle section: succinct name line, paragraph (or bullet list) capturing non‑negotiable rules, explicit rationale if not obvious.
72+
- Ensure Governance section lists amendment procedure, versioning policy, and compliance review expectations.
7373

7474
4. Consistency propagation checklist (convert prior checklist into active validations):
7575
- Read [`.specify/templates/plan-template.md`](../../.specify/templates/plan-template.md) and ensure any "Constitution Check" or rules align with updated principles.

‎.github/prompts/specify.prompt.md‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ Given that feature description, do this:
3030
If detected, extract the upstream repository information (owner/repo).
3131

3232
**If fork contribution is detected but information is incomplete**, prompt the user:
33-
```
33+
34+
```text
3435
Fork contribution detected. Please provide the following information:
3536
- Upstream organization/owner name (e.g., "microsoft", "PSModule")
3637
- Upstream repository name (e.g., "vscode", "PSModule")
@@ -51,12 +52,15 @@ Given that feature description, do this:
5152
- Examples: "user-authentication", "merge-workflows", "api-rate-limiting", "fix-memory-leak"
5253

5354
3. Run the script [`.specify/scripts/powershell/create-new-feature.ps1 -Json -FeatureDescription "$ARGUMENTS" -BranchName "<your-generated-name>"`](../../.specify/scripts/powershell/create-new-feature.ps1) from repo root and parse its JSON output for BRANCH_NAME, SPEC_FILE, and IS_EXISTING_BRANCH. All file paths must be absolute.
54-
**IMPORTANT** You must only ever run this script once. The JSON is provided in the terminal as output - always refer to it to get the actual content you're looking for.
55-
**NOTE**
56-
- The script will prepend an auto-incremented feature number (e.g., `003-`) to your branch name.
57-
- If you're currently on `main` branch, a new feature branch will be created.
58-
- If you're already on a feature branch (starts with 3 digits like `001-`, `002-`, etc.), you'll stay on that branch to iterate on the existing feature.
59-
- This allows you to refine specifications without creating multiple branches for the same feature.
55+
56+
**IMPORTANT** You must only ever run this script once. The JSON is provided in the terminal as output - always refer to it to get the actual content you're looking for.
57+
58+
**NOTE**
59+
60+
- The script will prepend an auto-incremented feature number (e.g., `003-`) to your branch name.
61+
- If you're currently on `main` branch, a new feature branch will be created.
62+
- If you're already on a feature branch (starts with 3 digits like `001-`, `002-`, etc.), you'll stay on that branch to iterate on the existing feature.
63+
- This allows you to refine specifications without creating multiple branches for the same feature.
6064

6165
4. **Store fork information (if detected in step 1)**:
6266
- If the user indicated this is a fork contribution, create a `.fork-info.json` file in the feature directory (same location as SPEC_FILE)

0 commit comments

Comments
 (0)