awesome-copilot/instructions/collections.instructions.md
Aaron Powell 56d7ce73a0
Partners (#354)
* initial prototype of partners collection with featured collection support

* Starting to add the partners

* Preparing the repo for how the custom agents will work

* moving some files around

* Moving a bunch of stuff around to make the file easier to read

* improving the front matter parsing by using a real library

* Some verbage updates

* some more verbage

* Fixing spelling mistake

* tweaking badges

* Updating contributing guide to be correct

* updating casing to match product

* More agents

* Better handling link to mcp registry

* links to install mcp servers fixed up

* Updating collection tags

* writing the mcp registry url out properly

* Adding custom agents for C# and WinForms

Expert custom agents to improve your experience when working with C# and WinForms in Copilot

* Adding to agents readme

* Adding PagerDuty agent

* Fixing description for terraform agent

* Adding custom agents to the README usage

* Removing the button to make the links more obvious

* docs: relocate category READMEs to /docs and update generation + internal links

* Updating prompts for new path

* formatting

---------

Co-authored-by: Chris Patterson <chrispat@github.com>
2025-10-29 06:07:13 +11:00

1.9 KiB

description applyTo
Guidelines for creating and managing awesome-copilot collections collections/*.collection.yml

Collections Development

Collection Instructions

When working with collections in the awesome-copilot repository:

  • Always validate collections using node validate-collections.js before committing
  • Follow the established YAML schema for collection manifests
  • Reference only existing files in the repository
  • Use descriptive collection IDs with lowercase letters, numbers, and hyphens
  • Keep collections focused on specific workflows or themes
  • Test that all referenced items work well together

Collection Structure

  • Required fields: id, name, description, items
  • Optional fields: tags, display
  • Item requirements: path must exist, kind must match file extension
  • Display options: ordering (alpha/manual), show_badge (true/false)

Validation Rules

  • Collection IDs must be unique across all collections
  • File paths must exist and match the item kind
  • Tags must use lowercase letters, numbers, and hyphens only
  • Collections must contain 1-50 items
  • Descriptions must be 1-500 characters

Best Practices

  • Group 3-10 related items for optimal usability
  • Use clear, descriptive names and descriptions
  • Add relevant tags for discoverability
  • Test the complete workflow the collection enables
  • Ensure items complement each other effectively

File Organization

  • Collections don't require file reorganization
  • Items can be located anywhere in the repository
  • Use relative paths from repository root
  • Maintain existing directory structure (prompts/, instructions/, chatmodes/)

Generation Process

  • Collections automatically generate README files via npm start
  • Individual collection pages are created in collections/ directory
  • Main collections overview is generated as README.collections.md
  • VS Code install badges are automatically created for each item