skills.rest
microsoft
microsoftOFFICIAL
Explore all skills by this author →
Website𝕏@OpenAtMicrosoftGitHub

fluid-pr-guide

Generates PR titles and descriptions following Fluid Framework repository conventions.

4.9k|585|Updated Aug 22, 2019
Search Tags:#Conventional Commits#gitHub#PR template#fluid framework#CI validation#Code review#Pull request
One-click install
npx skills add https://github.com/microsoft/FluidFramework --skill fluid-pr-guide
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: fluid-pr-guide
Source: https://github.com/microsoft/FluidFramework/tree/main/.claude/skills/fluid-pr-guide
Command: npx skills add https://github.com/microsoft/FluidFramework --skill fluid-pr-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing pull request titles and bodies that match the Fluid Framework repository's conventions is error-prone: there are two accepted title styles, a mandatory body template, and CI checks that fail on leftover placeholder text. This Skill guides the drafting and review of PR titles and descriptions so they pass validation on the first try.

Core Features & Use Cases

  • Title Style Guidance: Choose between Conventional Commits prefixes (e.g., fix(build-cli): ...) and plain imperative titles, with real examples from the repo and rules on what to avoid (like the bot-reserved [bump] prefix).
  • PR Body Template Application: Reads .github/pull_request_template.md and fills in each relevant section, removing placeholders and sections that do not apply.
  • CI Compliance Checks: Ensures the template preamble line is removed so the pr-validation.yml workflow does not fail, and that a ## Description section is always present.
  • Use Case: You just finished a bug fix in the id-compressor package. Ask the assistant to draft the PR, and it produces a properly scoped conventional-commit title plus a body with Description, Breaking Changes, and Reviewer Guidance sections filled in correctly.

Quick Start

Ask the assistant to write a PR title and description for your current Fluid Framework changes using the fluid-pr-guide conventions.

Frequently Asked Questions about fluid-pr-guide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a PR title for the Fluid Framework repo?▼

Use either a Conventional Commits prefix like `fix(build-cli): remove flaky test` or a plain imperative phrase like `Remove tree checkout's branch method`. Pick one style and do not mix them; never use the `[bump]` prefix, which is reserved for bot PRs.

What sections should a Fluid Framework PR description include?▼

Start from `.github/pull_request_template.md` and fill in relevant sections. A `## Description` section is always required; include Breaking Changes only for public API changes, and Reviewer Guidance with the wiki link. Delete sections that do not apply.

Why does the Fluid Framework PR validation CI check fail?▼

The `pr-validation.yml` workflow fails if the template preamble line 'Feel free to remove or alter parts of this template...' remains in the PR body. Remove that line and any leftover placeholder text before submitting.

When should I use conventional commits vs plain imperative PR titles?▼

Both styles appear in roughly equal proportion in the repo, so use whichever fits the change. Conventional Commits suits changes with a clear type and package scope; plain imperative works for straightforward refactors or removals. Do not mix the two styles.

How do I reference Azure DevOps work items in a GitHub PR?▼

Reference work items inline in the PR body using the `AB#<item-id>` format, such as `AB#12345`. No dedicated section is needed; place the reference where it provides context for the change.

Related Skills

Explore More Software Engineering Skills→
the-agency-aithe-agency-ai
39

pr-prep

Run quality gates and validate uncommitted code changes before pull requests.

Official
Intermediate
shiimanshiiman
2

pr-approve

Automates GitHub pull request approval after verifying CI status and code quality.

Community
Intermediate
yamcodesyamcodes
138

changeset

Create and modify changesets for semantic versioning and release notes.

Community
Intermediate
mauriciodelriomauriciodelrio
3

git-usage

Enforces Git commit message, branch naming conventions via commitlint and Husky.

Community
Advanced