Skip to content

Add YAML metadata blocks to GitHub agent markdown files#45

Merged
Malcolmnixon merged 2 commits intomainfrom
copilot/add-heading-to-markdown-files
Dec 27, 2025
Merged

Add YAML metadata blocks to GitHub agent markdown files#45
Malcolmnixon merged 2 commits intomainfrom
copilot/add-heading-to-markdown-files

Conversation

Copy link
Contributor

Copilot AI commented Dec 27, 2025

GitHub requires agent markdown files to have YAML front matter with name and description fields for proper recognition and display.

Changes

  • Added YAML metadata blocks to all three agent files:
    • documentation-writer.md
    • software-quality-enforcer.md
    • project-maintainer.md

Each file now begins with:

---
name: <Agent Name>
description: <Agent description summarizing responsibilities>
---

# <Agent Name>

The descriptions are derived from the agent summaries already documented in AGENTS.md, ensuring consistency across the repository.

Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature]: Add heading to github agent markdown files</issue_title>
<issue_description>### Problem Statement

The custom GitHub agent files aren't showing up in GitHub

Proposed Solution

The GitHub Agent markdown files MUST have a YAML metadata block specifying the agents name and description - such as:

---
name: <agent name>
description: <agent description>
---

# <Agent Name>

etc...

Alternatives Considered

No response

Usage Examples

Benefits

Make the agent files functional with GitHub

Priority

High - Blocking my use case

Willingness to Contribute

Yes, I can submit a pull request

Additional Context

No response

Checklist

  • I have searched existing issues to ensure this is not a duplicate
  • I have provided a clear description of the feature
  • I have explained why this feature would be useful</issue_description>

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: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Add heading to GitHub agent markdown files Add YAML metadata blocks to GitHub agent markdown files Dec 27, 2025
Copilot AI requested a review from Malcolmnixon December 27, 2025 17:14
@Malcolmnixon Malcolmnixon marked this pull request as ready for review December 27, 2025 17:16
@Malcolmnixon Malcolmnixon merged commit 2df6f5c into main Dec 27, 2025
8 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/add-heading-to-markdown-files branch December 27, 2025 17:16
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.

[Feature]: Add heading to github agent markdown files

2 participants