create-pr

Automate PR preparation with templates, local checks, and documentation updates.

515|64|Updated Oct 23, 2024

Search Tags:#documentation #formatting #code-quality #pr #ci #pull-request

Ready to run

npx skills add https://github.com/allenhutchison/obsidian-gemini --skill create-pr-allenhutchison

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: create-pr
Source: https://github.com/allenhutchison/obsidian-gemini/tree/main/.agents/skills/create-pr
Command: npx skills add https://github.com/allenhutchison/obsidian-gemini --skill create-pr-allenhutchison

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Preparing code changes for review is error-prone without consistent PR templates, checks, and updated docs.

Core Features & Use Cases

Enforce PR templates and auto-validate changes before submission.
Run local format, build, and tests to ensure code quality and prevent broken PRs.
Require documentation updates in the PR when changes affect user-facing features.

Quick Start

Open a new branch, run the prescribed checks locally, and create a PR using the repository's PR template.

Frequently Asked Questions about create-pr

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

FAQPage Schema

How do I automate pull request template validation and local checks before submission?▼

Automating pull request validation enforces repository templates, runs local formatting checks, executes builds and tests, and verifies documentation updates to prevent broken pull requests from being submitted for code review.

What's the best way to ensure documentation updates are included in a pull request?▼

The best way to ensure documentation updates are included in a pull request is to enforce pre-flight validation rules that require documentation changes whenever code modifications affect user-facing features before opening the request.

Can I run local format checks and build tests automatically when preparing code changes for review?▼

Yes, you can run local format checks and build tests automatically during pull request preparation to validate code quality, ensure compilation succeeds, and prevent broken pull requests from reaching the review stage.

Why do my pull requests fail pre-flight requirements even after passing local compilation?▼

Pull requests fail pre-flight requirements after passing local compilation because the validation process also checks for PR template usage, formatting compliance, test execution success, and required documentation updates for changed features.

How do I enforce consistent PR templates across a development team?▼

To enforce consistent PR templates across a development team, automate the pull request preparation workflow to validate that submissions follow the repository's template, pass local checks, and include necessary documentation updates before code review.