core-pr-helper

Generate a standards-compliant branch name and PR description for Calimero core PRs.

165|36|Updated Jan 22, 2024
One-click install
npx skills add https://github.com/calimero-network/core --skill core-pr-helper
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: core-pr-helper
Source: https://github.com/calimero-network/core/tree/main/.cursor/skills/core-pr-helper
Command: npx skills add https://github.com/calimero-network/core --skill core-pr-helper

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the generation of a single, standards-compliant branch name and PR description for Calimero core PRs.

Core Features & Use Cases

  • One-branch name generation: Produces a single, properly formatted branch name following the repository conventions.
  • PR description template: Outputs a PR body containing Title, Description, Test plan, and Documentation update sections ready to paste into the template.
  • Usage scenarios: Use when creating a core PR, or when you need a branch name and PR description for any core-related change.

Quick Start

Ask the skill to generate a branch name and PR description for a Calimero core PR.

Frequently Asked Questions about core-pr-helper

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

FAQPage Schema
How do I generate a branch name and PR description for a Calimero core pull request?

To generate a branch name and PR description for a Calimero core pull request, use an automation tool that outputs a single standards-compliant branch name and a structured PR body. This ensures your pull request follows repository conventions for type, scope, and summary formatting.

What format should a Calimero core branch name follow?

A Calimero core branch name should follow the type-scope-short-summary pattern. This naming convention ensures consistency across pull requests by clearly identifying the commit type, the affected scope, and a brief summary of the code changes.

What sections are required in a Calimero core PR description template?

A Calimero core PR description template requires four specific sections: Title, Description, Test plan, and Documentation update. Including these sections ensures the pull request provides comprehensive context and verification steps for code reviewers.

When do I need to use a standardized PR template for code review?

You need to use a standardized PR template for code review when creating a Calimero core PR or making any core-related change. Applying this template ensures your pull request meets repository standards and provides necessary documentation updates.

Can I generate multiple branch name suggestions for a single pull request?

No, the generation process produces exactly one branch name following the type-scope-short-summary pattern. This single-branch name generation approach ensures strict adherence to repository conventions without offering alternative naming options.

Does the PR description generator include a test plan section?

Yes, the PR description generator includes a dedicated Test plan section. This section is a mandatory part of the PR body template, ensuring that all code changes are accompanied by clear verification steps for reviewers.