skills.rest
devkade
devkadeCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

oss:documentation-pr

Generate PR titles, descriptions, changelogs, and pre-PR checklists for OSS contributions.

2|1|Updated Oct 23, 2025
Search Tags:#workflow#changelog#documentation#contributing#code-review#pull-request
One-click install
npx skills add https://github.com/devkade/collaborator --skill oss-documentation-pr
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: oss:documentation-pr
Source: https://github.com/devkade/collaborator/tree/main/skills/oss-contribution-framework/skills/documentation-pr
Command: npx skills add https://github.com/devkade/collaborator --skill oss-documentation-pr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill guides creating a comprehensive pull request for OSS contributions, including documentation, changelog entries, and a clear, review-ready description that accelerates merging.

Core Features & Use Cases

  • PR Title & Description: Generate precise, actionable PR title and description that explain what changed and why.
  • Documentation & Changelog: Create changes documentation and changelog entries to capture impact.
  • Review Readiness: Produce a complete pre-PR checklist and branch hygiene steps to ensure review readiness.
  • Use Case: When finishing implementation, you can rely on this skill to assemble crisp PR artifacts that pass contributing guidelines.

Quick Start

Use the oss:documentation-pr skill to generate a PR-ready description for your completed feature branch, including the title, description, and checklist. Then copy-paste into your PR.

Frequently Asked Questions about oss:documentation-pr

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

FAQPage Schema
How do I write a pull request description for an open source contribution?▼

To write a pull request description for an open source contribution, you need a clear title, an explanation of what changed and why, and a pre-PR checklist. This ensures your submission is review-ready and passes contributing guidelines.

What should be included in OSS documentation before submitting a code review?▼

OSS documentation before a code review should include comprehensive changes documentation and changelog entries. Capturing this impact ensures reviewers understand the implementation scope and helps accelerate the merging process.

How do I make sure my pull request complies with CONTRIBUTING.md requirements?▼

To make sure your pull request complies with CONTRIBUTING.md requirements, enforce proper PR formatting and generate a complete pre-PR checklist. This verifies branch hygiene and ensures all contribution guidelines are met before submission.

What is the best way to format a changelog entry for a feature branch?▼

The best way to format a changelog entry for a feature branch is to document the specific impact of the changes. Generating clear changelog artifacts alongside your PR description captures what was modified and why it matters for the project.

Does this PR formatting workflow work after implementation is complete?▼

Yes, this PR formatting workflow applies specifically when your implementation is complete and ready for submission. It assembles crisp PR artifacts, including titles, descriptions, and checklists, from your finished feature branch.

Related Skills

Explore More Software Engineering Skills→
Goblin1024Goblin1024
6

git-master

Coordinate Git workflows for atomic commits, safe rebases, and clean history.

Community
Advanced
richkuorichkuo
45

work-on-issue-loop

Automate GitHub issue implementation, pull request creation, and review feedback resolution.

Community
Advanced
deMGoncalvesdeMGoncalves
4

Guardian Skill

Validate commits and release readiness with linters, tests, builds, and CI/CD simulations.

Community
Intermediate
HiroyukiMakitaHiroyukiMakita

pr-creator

Create compliant pull requests using repository templates and the gh CLI.

Community
Intermediate