skills.rest
christian-deleon
christian-deleonCOMMUNITY
Explore all skills by this author →
Website𝕏@realchrisdeleonGitHub

contribute

Automate open-source GitHub contributions from conventions to pull requests.

Updated Jul 15, 2024
Search Tags:#contribution#commit messages#GitHub#open-source#PR creation
One-click install
npx skills add https://github.com/christian-deleon/dotfiles --skill contribute-christian-deleon
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: contribute
Source: https://github.com/christian-deleon/dotfiles/tree/main/ai/skills/contribute
Command: npx skills add https://github.com/christian-deleon/dotfiles --skill contribute-christian-deleon

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git, gh, and includes scripts (resource) components.

What problem does it solve?

This Skill streamlines the process of contributing to open-source GitHub projects by guiding users through the contribution process, including reading project conventions, preparing branches, adapting commit messages, running tests, and creating pull requests.

Core Features & Use Cases

  • Project Convention Detection: Automatically reads CONTRIBUTING.md, PR templates, and git logs to identify project conventions.
  • Branch Preparation: Helps in setting up the correct branch names and syncing with upstream.
  • Commit Convention Adaptation: Assists in adapting commit messages to project conventions and requirements.
  • Pre-PR Checklist: Ensures code quality, tests, and CI checks are completed before creating a pull request.
  • Pull Request Creation: Guides in filling out PR templates, linking issues, and creating the PR with the gh CLI.

Quick Start

Use the contribute skill to start a new pull request for the 'fix/null-pointer-empty-input' branch in the 'upstream/main' remote.

Frequently Asked Questions about contribute

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

FAQPage Schema
How do I automate pull request creation for open-source GitHub projects?▼

Automating pull request creation for open-source GitHub projects involves detecting conventions from CONTRIBUTING.md, syncing with upstream, and using the gh CLI to submit. This Skill orchestrates that entire workflow.

How do I ensure my commit messages match an open-source project's conventions?▼

To match commit message conventions, you need to read the project's git logs and CONTRIBUTING.md file. This Skill automatically detects these conventions and helps you adapt your commit messages accordingly before submission.

Do I need the GitHub CLI to contribute to open-source repositories?▼

Yes, you need both git and the GitHub CLI (gh) installed to interact with repositories and create pull requests. These dependencies are required for branch preparation, syncing upstream, and executing the final PR creation.

What is included in a pre-PR checklist for open-source contributions?▼

A pre-PR checklist for open-source contributions ensures code quality, tests, and CI checks are completed before creating a pull request. This Skill enforces that checklist to verify everything passes prior to submission.

Can I automatically detect project conventions before creating a GitHub PR?▼

You can detect project conventions by automatically reading CONTRIBUTING.md, PR templates, and git logs. This Skill identifies the required formatting and branching rules to ensure your contribution adheres to repository standards.

Related Skills

Explore More Software Engineering Skills→
kriscendobotkriscendobot
3

frozen-base-branch

Create and maintain frozen base branches for fork-side pull requests.

Community
Advanced
JeremyKuhneJeremyKuhne
9

create-pr

Create pull requests from feature branches to target main branches.

Community
Intermediate
xxihxxih
1

springboot-verification

Validate Spring Boot applications with build, static analysis, coverage, and security scans.

Community
Advanced
udecodeudecode
1.2k

drafting-pr

Create and update GitHub draft pull requests with conventional commits.

Official
Intermediate