Централизованное управление контекстом для GitHub Copilot в канонической экосистеме.

Этот репозиторий действует как «Toolkit» для распространения стандартизированных пользовательских инструкций, инструкций, агентов и навыков Copilot. Он позволяет отдельным репозиториям «подписываться» на определенные наборы активов (например, стандарты Python, шаблоны Juju / Ops Framework) и автоматически синхронизировать их.

##Что такое коллекционирование?

**Коллекция ** представляет собой логическую группу файлов разметки (инструкции, подсказки, агенты и навыки), определенных в collections.yaml.

Вместо того, чтобы копировать конкретные инструкции в 50 различных репозиториев вручную, репозиторий определяет конфигурационный файл, перечисляющий необходимые ему коллекции.

** Доступные коллекции (примеры): **

Ядро: основные активы, общие для всех репозиториев. Common-python: Стандартный стиль кодирования Python.

• Common-documentation: стандарты документации с навыками рецензирования.
• charm-python: Включает спецификации Common-python + Juju Ops Framework. Copilot-toolkit: Мета-инструменты для создания и управления активами Copilot (агенты, навыки, подсказки, инструкции).
• pfe-charms: Platform Engineering Specific Collection.

##Использование: Добавление в хранилище

Canonical Copilot Collections

Centralized context management for GitHub Copilot across the Canonical ecosystem.

This repository acts as a “Toolkit” to distribute standardized Copilot Custom Instructions, Prompts, Agents and Skills. It allows individual repositories to “subscribe” to specific sets of assets (e.g., Python standards, Juju/Ops Framework patterns) and keep them synchronized automatically.

What are Collections?

A Collection is a logical group of markdown files (instructions, prompts, agents, and skills) defined in collections.yaml.

Instead of copying specific instructions into 50 different repositories manually, the consuming repository defines a configuration file listing the collections it needs.

Available Collections (Examples):

• core: Core assets common to all repositories.
• common-python: Standard Python coding style.
• common-documentation: Documentation standards with review skill.
• charm-python: Includes common-python + Juju Ops Framework specifics.
• copilot-toolkit: Meta-tools for generating and managing Copilot assets (agents, skills, prompts, instructions).
• pfe-charms: Platform Engineering specific collection.

Usage: Adding to a Repository

To add Copilot collections to your repository, follow these three steps.

Note: These steps assume that if the yq tool is already installed, it was installed via snap not via apt. The install scripts rely on behavior from the snap version of yq. The apt offering of yq doesn’t have the behavior the scripts expect, and will fail. If yq is not installed, the script will automatically install it via snap.

1. Create the Configuration

Create a file named .copilot-collections.yaml in the .github folder of your repository (recommended) or in the repository root.

copilot:
  # The version of the toolkit to use (matches a Release Tag in this repo)
  version: "v1.0.0"

  # The collections you want to install
  collections:
    - charm-python
    - pfe-charms

Location Preference: The workflow and sync script will search for the config file in this order:

1. .github/.copilot-collections.yaml (recommended)
2. .copilot-collections.yaml (root, for backwards compatibility)

You can also specify a custom location - see below for details.

2. Run the Initial Sync (Local)

You can sync the instructions immediately to your local machine to verify them.

curl -sL https://raw.githubusercontent.com/canonical/copilot-collections/main/scripts/local_sync.sh | bash

To specify a custom config file location:

# Via command-line argument
curl -sL https://raw.githubusercontent.com/canonical/copilot-collections/main/scripts/local_sync.sh | bash -s -- custom/path/.copilot-collections.yaml

# Via environment variable