clickhouse-pr-description

Generate ClickHouse pull request descriptions from Git diffs and templates.

1|Updated Jul 29, 2024
One-click install
npx skills add https://github.com/codacy-open-source-projects-scans/clickhouse --skill clickhouse-pr-description
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: clickhouse-pr-description
Source: https://github.com/codacy-open-source-projects-scans/clickhouse/tree/main/.claude/skills/clickhouse-pr-description
Command: npx skills add https://github.com/codacy-open-source-projects-scans/clickhouse --skill clickhouse-pr-description

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you generate Pull Request (PR) descriptions for the ClickHouse project that adhere to the maintainers' strict guidelines, avoiding common AI-generated phrasing and ensuring clarity and conciseness.

Core Features & Use Cases

  • Automated Description Generation: Creates PR descriptions based on Git diffs and project conventions.
  • Maintainer Guideline Adherence: Strips out "AI slop" and formats titles and bodies according to ClickHouse standards.
  • Use Case: When submitting a code change to the ClickHouse repository, use this Skill to ensure your PR description is professional, informative, and meets the project's specific requirements, increasing the likelihood of a swift review.

Quick Start

Use the clickhouse-pr-description skill to generate a PR description for the current branch.

Frequently Asked Questions about clickhouse-pr-description

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

FAQPage Schema
How do I generate a ClickHouse PR description from a git diff?

You generate a ClickHouse PR description by analyzing your git diff and commit history using GitHub CLI. The skill formats the branch changes into a human-readable title, body, and changelog entry that strictly adheres to ClickHouse maintainer guidelines.

Why are my AI-generated GitHub PR descriptions rejected by ClickHouse maintainers?

ClickHouse maintainers reject AI-generated PR descriptions because they often contain generic phrasing and conventional commit syntax. The skill avoids this AI slop by formatting titles and bodies according to strict project standards, ensuring professional and informative documentation.

Does this ClickHouse PR generator require conventional commit syntax?

No, this ClickHouse PR generator explicitly avoids conventional commit syntax. It analyzes your git diff and commit history to produce human-readable descriptions that align directly with the specific title and body format expected by ClickHouse maintainers.

Can I use GitHub CLI to fetch commit history for ClickHouse pull requests?

Yes, you can use GitHub CLI and Git commands to fetch commit history and diff information. The skill supports fetching this PR data directly to analyze your branch changes and automatically generate the required ClickHouse changelog entries and description body.

What is the best way to format a ClickHouse changelog entry for a pull request?

The best way to format a ClickHouse changelog entry is to analyze the git diff against project templates. This skill automatically generates the changelog entry alongside the PR title and body, ensuring the exact formatting expected by ClickHouse maintainers without any AI-generated filler.

What should I avoid when writing a ClickHouse PR description?

When writing a ClickHouse PR description, you should avoid AI-generated phrasing and conventional commit syntax. The skill strips out this AI slop and formats the title, body, and changelog based on your actual git diff to meet strict maintainer expectations.