Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (38 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) · 3.56 KB
Raw

Contributing to the Spec Kit Copilot Plugin

Hi there! We're thrilled that you'd like to contribute to the Spec Kit Copilot Plugin. Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

About this repository

This repository is a GitHub Copilot CLI skills plugin. It does not contain application code — it is a set of Markdown skill files that teach the Copilot agent how and when to drive the Spec Kit specify CLI. Its layout is:

  • plugin.json — the plugin manifest (required).
  • skills/<name>/SKILL.md — one skill per specify command group (YAML frontmatter + Markdown body).
  • .github/plugin/marketplace.json — the marketplace manifest used for distribution.
  • AGENTS.md — maintainer guidance and the design decisions behind the plugin. Read this before adding, removing, or regenerating skills.

Prerequisites

  1. Install the GitHub Copilot CLI.

  2. Install the Spec Kit specify CLI (used to enumerate the command surface the skills wrap):

    uv tool install specify-cli   # or: pipx install specify-cli
specify --version

Making a change

  1. Fork and clone the repository.

  2. Create a new branch: git checkout -b <type>/<short-slug>.

  3. Make your change. When editing skills, keep the design decisions in AGENTS.md intact — in particular, the integration is always Copilot in skills mode, and there is intentionally no integration-management skill.

  4. Install the plugin locally and verify it loads with the expected skill count:

    copilot plugin install ./
copilot plugin list

  5. Push to your fork and submit a pull request.

  6. Wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Keep each SKILL.md focused on a single specify command group, with a discovery-oriented description (USE FOR / DO NOT USE FOR) and an accurate list of subcommands and options.
  • Keep the change as focused as possible. If there are multiple unrelated changes, submit them as separate pull requests.
  • Write a good commit message.
  • Update the README and AGENTS.md if your change affects behavior or the skill set.

Versioning

This plugin is not pinned to a specific specify CLI version — it targets the latest specify-cli published on PyPI, with a minimum floor of >= 0.11 for the bundle / workflow step skills. The plugin's own version in plugin.json (and .github/plugin/marketplace.json) is an independent semver that tracks changes to the plugin/skills, not the CLI release. When revving, bump plugin.json and both .github/plugin/marketplace.json versions together, and update the README "Versioning" note. See AGENTS.md for the full checklist.

Resources