Skip to content

Conversation

@samcarrington
Copy link
Collaborator

Pull Request

Summary

This PR updates chatmode files to reference renamed tools and includes various documentation and formatting improvements.

Quality & Policy Checks

  • Branch/PR rules followed (see .github/copilot-instructions.md)
  • Brings current markdown into passing state for existing actions
  • Docs updated - not applicable
  • Security and privacy considerations noted

Notes for Reviewers

  • Exclusion was added for the linting task to exclude the .github folder from linting.
    • This was mainly due to raw HTML/XML in markdown used for LLM instruction breaking the linting rule.
    • Change to the actual chatmode files considered OOS without spec and testing.

- Add consistent blank lines after headings
- Fix list formatting and indentation
- Standardize table formatting
- Remove trailing whitespace
- Ensure proper spacing in documentation files

Files updated:
- .github/pull_request_template.md
- docs/ADRs/adr-template.md
- docs/PRDs/prd-template.md
- docs/README.md
- docs/architecture/README.md
- docs/engineering/code-review-guidelines.md
- docs/engineering/pull-request-guidelines.md
- plans/README.md
- plans/ROADMAP.md
- plans/TODO.md
- plans/archive/enhance-copilot-instructions-todos-plan.md
- plans/examples/plan-small.md
- plans/plan-template.md
@samcarrington samcarrington requested review from Copilot and pidster and removed request for pidster October 20, 2025 08:41
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Updates documentation and configuration to align with renamed agent/chatmode tool identifiers and improves Markdown formatting consistency (tables, spacing, headings). Primary functional change is the renaming of tool keys in chatmode and prompt frontmatter; other edits refine structure and clarity of docs.

  • Renamed tool identifiers across chat modes and prompt files.
  • Added formatting/structural adjustments in multiple Markdown documents (tables, headings, spacing).
  • Introduced lint exclusion for .github markdown files.

Reviewed Changes

Copilot reviewed 28 out of 31 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
recommendations.md Formatting adjustments (table separators, blank lines) supporting clarity of assessment matrix.
plans/plan-template.md Adds list formatting and code fence languages for better structured plan authoring.
plans/examples/plan-small.md Adds spacing for readability in example plan.
plans/archive/enhance-copilot-instructions-todos-plan.md Formatting changes; introduces a malformed combined heading/list line needing correction.
plans/archive/README.md Removes trailing blank line for cleanliness.
plans/TODO.md Converts top heading, adjusts table separators for clarity.
plans/ROADMAP.md Adds spacing around sections for readability.
plans/README.md Adds spacing to improve section separation.
docs/engineering/pull-request-guidelines.md Adds spacing; minor capitalization issue persists.
docs/engineering/code-review-guidelines.md Converts numbered section labels into Markdown subheadings; improves structure; capitalization issue persists.
docs/engineering/README.md Removes trailing whitespace.
docs/architecture/README.md Fixes broken ADR link path.
docs/README.md Adjusts heading level; minor capitalization issue persists.
docs/PRDs/prd-template.md Adds spacing and normalizes tables.
docs/ADRs/adr-template.md Removes title field from frontmatter (metadata regression).
README.md Adjusts headings and code block fences; several spelling/capitalization issues persist.
AGENTS.md Adds spacing; contains pluralization/capitalization issue.
.github/workflows/docs-lint.yml Adds exclusion for .github markdown files to prevent lint failures.
.github/pull_request_template.md Adds spacing for sections.
.github/prompts/write-prd.prompt.md Renames tools to new identifiers.
.github/prompts/write-ears-spec.prompt.md Renames tools to new identifiers.
.github/prompts/write-docs.prompt.md Renames tools to new identifiers.
.github/prompts/write-adr.prompt.md Renames tools to new identifiers.
.github/prompts/copilot-setup-check.prompt.md Adds spacing for section readability.
.github/chatmodes/Planner.chatmode.md Renames tools to new identifiers.
.github/chatmodes/Documentation.chatmode.md Renames tools to new identifiers.
.github/chatmodes/Developer.chatmode.md Renames tools to new identifiers.
.github/chatmodes/CodeReviewer.chatmode.md Renames tools to new identifiers.

@pidster pidster self-assigned this Oct 20, 2025
samcarrington and others added 11 commits October 20, 2025 11:06
copilot spellcheck

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@samcarrington samcarrington merged commit 2f75a69 into main Oct 20, 2025
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants