commit-conventions

Enforce commit prefixes, reviewer tags, and default test plans for git commits.

7.2k|451|Updated Nov 10, 2017
One-click install
npx skills add https://github.com/facebook/pyre-check --skill commit-conventions-facebook
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-conventions
Source: https://github.com/facebook/pyre-check/tree/main/.llms/skills/commit-conventions
Command: npx skills add https://github.com/facebook/pyre-check --skill commit-conventions-facebook

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Commit hygiene and clarity by ensuring every change uses the correct title prefix, reviewer assignment, and test plan based on the area of the codebase being changed.

Core Features & Use Cases

  • Enforces the use of [pysa] or [pyre] prefixes in commit titles depending on the nature of the change.
  • Automatically assigns the appropriate reviewer tags (e.g., #pysa or #pyre) to streamline code reviews.
  • Establishes a default test plan to maintain consistency across changes.

Quick Start

Start each change with the appropriate prefix, assign the reviewer, and apply the default test plan.

Frequently Asked Questions about commit-conventions

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

FAQPage Schema
How do I enforce consistent git commit prefixes for code reviews?

When you prefix commit titles with [pysa] or [pyre], the mechanism determines the appropriate reviewer tag, such as #pysa or #pyre, based on the nature of the change. This ensures the correct reviewers are tagged for the modified codebase area.

How do I start applying commit conventions and test plans to my git workflow?

You should use the [pysa] prefix when committing changes related to the pysa area of the codebase, and the [pyre] prefix for pyre-related changes. This distinction ensures the correct reviewer tags are assigned to streamline the code review process.

Do I need a test plan for every git commit using pyre or pysa prefixes?

Using this commit convention mechanism does not require external dependencies. It operates directly on git commits and diffs to apply prefixes, assign reviewers, and establish default test plans, ensuring commit hygiene without additional environment setup.

Are there limitations to automating commit prefix and reviewer assignment?

This approach assigns default test plans and static reviewer tags like #pysa or #pyre. Other tools in the same category might offer more flexible custom prefix mapping or dynamic reviewer routing based on complex codebase logic instead of fixed tags.