pr-conventions

Enforce conventional commit formatting and complete PR descriptions for divine-web workflows.

46|28|Updated Sep 8, 2025
One-click install
npx skills add https://github.com/divinevideo/divine-web --skill pr-conventions-divinevideo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-conventions
Source: https://github.com/divinevideo/divine-web/tree/main/.agents/skills/pr-conventions
Command: npx skills add https://github.com/divinevideo/divine-web --skill pr-conventions-divinevideo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It eliminates inconsistencies in commit messages and pull request submissions so reviewers can quickly understand intent, scope, and verification results.

Core Features & Use Cases

  • Conventional commit formatting: Enforces imperative, present-tense commit messages and a conventional PR title structure using allowed types and optional scopes.
  • Complete PR descriptions: Requires the repository’s PR template fields to be filled (summary, motivation, related issue, testing checklist, visuals checklist) to reduce back-and-forth.
  • Guardrails for scope and hygiene: Promotes one PR per concern, discourages bundled unrelated changes, mandates rebase and test passing before opening a PR, and sets rules for branding and transitional code.

Quick Start

Ask an AI assistant to draft a commit message and PR description for your change according to divine-web’s PR conventions, including the testing and visuals checklists.

Frequently Asked Questions about pr-conventions

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

FAQPage Schema
How do I write a conventional commit message for a pull request?

To write conventional commit messages, use imperative, present-tense verbs and a structured title with allowed types and optional scopes, ensuring reviewers quickly understand the change intent and boundaries.

What should be included in a pull request description for faster code review?

A complete pull request description includes the summary, motivation, related issue, testing checklist, and visuals checklist, reducing review back-and-forth by documenting verification results.

How do I prepare a branch before opening a pull request on GitHub?

Before opening a pull request on GitHub, you must rebase your branch, ensure all tests pass, and maintain a clean git status to enforce branch hygiene and scope control.

Why should pull requests contain only a single concern?

Pull requests should contain a single concern to prevent bundling unrelated changes, allowing reviewers to verify intent, scope, and branding restrictions without friction.

Can I track transitional TODOs in my code before submitting a PR?

Transitional TODO tracking rules apply before submitting a PR, requiring you to document incomplete work alongside testing and visual verification checklists in the pull request template.