Skip to content

docs: add branch-reviewer agent to Workflows table in README#47

Merged
jkordick merged 2 commits intomainfrom
copilot/update-readme-branch-reviewer-agent
Feb 23, 2026
Merged

docs: add branch-reviewer agent to Workflows table in README#47
jkordick merged 2 commits intomainfrom
copilot/update-readme-branch-reviewer-agent

Conversation

Copy link
Contributor

Copilot AI commented Feb 23, 2026

The .github/agents/branch-reviewer.agent.md custom Copilot CLI agent was missing from the Workflows table at the bottom of README.md, despite documentation conventions requiring all workflows, CI/CD pipelines, and agents to be listed there.

Changes

  • README.md: Updated the Workflows table header from Workflow to Workflow / Agent and added a row for the Branch Reviewer agent:
| [Branch Reviewer](.github/agents/branch-reviewer.agent.md) | On demand (Copilot CLI) | Reviews branch changes, summarizes commits, and detects breaking changes vs. `main` |
Original prompt

This section details on the original issue you should resolve

<issue_title>[docs] Documentation update needed for push to main by @jkordick</issue_title>
<issue_description>## Summary

Commit 64dccf89 added a new custom agent (.github/agents/branch-reviewer.agent.md) directly to main. The follow-up PR #44 (commit 429cf80) added a Workflows section to README.md, but the branch-reviewer agent is not listed in that section.

What Changed

  • Added: .github/agents/branch-reviewer.agent.md — a custom Copilot CLI agent for reviewing branch changes, summarizing commits, detecting breaking changes vs. main, and assessing PR readiness.

Documentation Gap

According to the documentation instructions:

Workflows, CI/CD pipelines and agents should be mentioned in a short list on the bottom of the README.md.

The current README.md Workflows table (bottom of the file) lists the three CI/CD workflows but omits the branch-reviewer agent entirely.

Suggested Fix

Add a row for the branch-reviewer agent to the Workflows table in README.md:

| [Branch Reviewer](.github/agents/branch-reviewer.agent.md) | On demand (Copilot CLI) | Reviews branch changes, summarizes commits, and detects breaking changes vs. `main` |

The updated table would look like:

Workflow / Agent Trigger Description
Documentation Updater Push / PR to main Checks documentation completeness and reports gaps via issues or PR comments
Documentation Audit Weekly schedule Performs a full audit of project documentation for accuracy and completeness
Test Enhancer On demand Agentic workflow that analyzes the codebase and proposes improvements to test coverage
Branch Reviewer On demand (Copilot CLI) Reviews branch changes, summarizes commits, and detects breaking changes vs. main

Generated by Documentation Updater

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: jkordick <52427852+jkordick@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation for branch-reviewer agent in README docs: add branch-reviewer agent to Workflows table in README Feb 23, 2026
@jkordick jkordick marked this pull request as ready for review February 23, 2026 12:45
@jkordick jkordick merged commit 0a27703 into main Feb 23, 2026
14 checks passed
@jkordick jkordick deleted the copilot/update-readme-branch-reviewer-agent branch February 23, 2026 12:48
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.

[docs] Documentation update needed for push to main by @jkordick

2 participants