skills.rest
adikpb
adikpbCOMMUNITY
Explore all skills by this author →
GitHub

oss-contribution-prep

Guides reading of governing repository documents before opening open-source pull requests.

1|Updated Mar 15, 2025
Search Tags:#code review#documentation#pull request#github#contributing#open-source#oss
One-click install
npx skills add https://github.com/adikpb/dotfiles --skill oss-contribution-prep-adikpb
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: oss-contribution-prep
Source: https://github.com/adikpb/dotfiles/tree/main/.hermes/skills/github/oss-contribution-prep
Command: npx skills add https://github.com/adikpb/dotfiles --skill oss-contribution-prep-adikpb

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Pull requests get closed when contributors skip the rules maintainers wrote down in README, CONTRIBUTING, and PR templates. This Skill enforces a pre-contribution checklist so every PR follows the target repository's documented conventions before submission. ## Core Features & Use Cases - Governing docs checklist: Read README, CONTRIBUTING, CODE_OF_CONDUCT, LICENSE, SECURITY, .github templates, and agent instruction files (AGENTS.md, CLAUDE.md, .cursorrules) before creating a branch. - PR template compliance: Write PR bodies matching the repository's PULL_REQUEST_TEMPLATE.md sections verbatim, with honest checklist boxes and required regression tests for bug fixes. - Pre-submit verification: Re-read governing docs and verify the live PR via gh CLI for stale content, mergeable state, conventional commits, and draft readiness. - Use Case: Before opening a PR against an unfamiliar open-source repo, run this checklist to fetch its CONTRIBUTING.md, match its PR template exactly, and verify the live PR metadata with gh pr view. ## Quick Start Before I open a PR on this repository, read its governing markdown files and verify my PR against its template and contributing rules.

Frequently Asked Questions about oss-contribution-prep

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

FAQPage Schema
What files should I read before contributing to an open-source repo?▼

Read README, CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE, SECURITY.md, and the .github directory including PULL_REQUEST_TEMPLATE.md and CODEOWNERS. Also check for agent instruction files like AGENTS.md, CLAUDE.md, or .cursorrules, which override default behavior.

How do I write a PR body that follows a repository template?▼

Fetch the repo's .github/PULL_REQUEST_TEMPLATE.md first and reproduce its sections verbatim, adding content inside them without omitting or renaming headings. Fill checklist boxes honestly, delete non-applicable sections, and pass the body via gh pr edit with --body-file to avoid shell escaping issues.

How do I verify a GitHub PR is ready before submitting?▼

Re-read the governing docs, then check the live PR with gh pr view --json state,mergeable,baseRefOid,headRefOid to confirm it is mergeable and based on current main. Grep the live body for stale content, ensure exactly one Type of Change box is checked, and flip drafts with gh pr ready.

Do I need tests for a bug fix pull request?▼

Yes, most templates require tests for bug fixes. Write a regression test that reproduces the bug and commit it separately with a conventional commit message like test(scope): description before marking the tests checklist box.

When can I mark documentation checklist items as N/A on a PR?▼

Only after actually checking. Grep the docs directory for keywords related to your change and inspect example configuration files for the changed surface. Marking N/A by assumption without checking is how PRs get rejected.

Related Skills

Explore More Software Engineering Skills→
majiayu000majiayu000
258

contributor

Plan and execute open-source contributions from issue discovery to PR submission.

Community
Advanced
founderphantomfounderphantom

github-pr-workflow

Automate GitHub PR lifecycle from branch creation to merge.

Community
Advanced
managedcodemanagedcode
4

mcaf-solution-governance

Create and update AGENTS.md governance files for MCAF repositories.

Official
Advanced
Camilo8902Camilo8902

pr-template-builder

Generate standardized GitHub templates for pull requests, issues, and discussions.

Community
Intermediate