skills.rest
esphome
esphomeOFFICIAL
Explore all skills by this author →
Website𝕏@esphome_GitHub

pr-workflow

Create aioesphomeapi pull requests following branch, template, and commit conventions.

194|100|Updated Dec 13, 2018
Search Tags:#contribution#pull request#git workflow#github#protobuf#commit conventions#template filling
One-click install
npx skills add https://github.com/esphome/aioesphomeapi --skill pr-workflow-esphome
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-workflow
Source: https://github.com/esphome/aioesphomeapi/tree/main/.claude/skills/pr-workflow
Command: npx skills add https://github.com/esphome/aioesphomeapi --skill pr-workflow-esphome

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It reduces mistakes and delays when creating pull requests by ensuring you follow the repository’s contribution workflow, template requirements, and commit conventions.

Core Features & Use Cases

  • PR preparation from the latest main: Always creates a branch off the most recent origin/main to minimize merge conflicts.
  • Correct PR template completion: Fills every required section in .github/PULL_REQUEST_TEMPLATE.md, including exactly one “Types of changes” selection and a truthful checklist.
  • Protocol change guardrail: Ensures any api.proto edits also include the required upstream firmware-side change in esphome/esphome, and regeneration of protobuf bindings to keep api_pb2.py in sync.
  • Commit hygiene: Enforces imperative subject lines, avoids Co-Authored-By: Claude, and encourages single logical changes with pre-commit checks.

Quick Start

Create a branch from the latest origin/main, read and fill the repository PR template verbatim (including all checkboxes), and if you changed api.proto first land the matching esphome/esphome change and regenerate protobuf bindings before pushing and opening the PR.

Frequently Asked Questions about pr-workflow

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

FAQPage Schema
How do I create a pull request for aioesphomeapi without merge conflicts?▼

To create a pull request for aioesphomeapi without merge conflicts, branch from the latest origin/main. This ensures your changes are built on the most recent codebase before submitting.

What is the correct way to fill out the aioesphomeapi PR template?▼

The correct way to fill the PR template is verbatim, keeping all sections and checkboxes intact. You must select exactly one type of change and provide a truthful checklist before opening the pull request.

Do I need to regenerate protobuf bindings if I edit api.proto?▼

Yes, if you edit api.proto you must regenerate the protobuf bindings to keep api_pb2.py synchronized. You also need to link the matching upstream firmware-side change in esphome/esphome.

What commit conventions are required for aioesphomeapi pull requests?▼

Commit conventions for aioesphomeapi require imperative subject lines and single logical changes. You must avoid Co-Authored-By: Claude tags and run pre-commit checks before pushing your branch.

Why does my aioesphomeapi pull request fail the protocol change guardrail?▼

Your pull request fails the protocol change guardrail if you modified api.proto without linking the upstream esphome/esphome firmware change. The repository requires both changes to be submitted together to pass.

Related Skills

Explore More Software Engineering Skills→
flurdyflurdy
6

rebase-main

Rebase the current feature branch onto origin/main with conflict handling and status reporting.

Community
Intermediate
julianobarbosajulianobarbosa
7

Git

Automate Git commit, branch, merge, and PR workflows with GitHub CLI and security checks.

Community
Advanced
dotnetdotnet
18.2k

add-new-jit-ee-api

Automate new JIT-VM API integration across .NET runtime layers.

Official
Advanced
fixpoint-labsfixpoint-labs
2

fsd:create-issue-and-commit

Create a Linear issue, branch, commit, and pull request via git and GitHub API.

Official
Advanced