skills.rest
rodacato
rodacatoCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

contributing

Create or update CONTRIBUTING.md with structured contributor guidance.

Updated Mar 28, 2026
Search Tags:#contributing#workflows#pull-requests#branch-naming#dev-environment#contributing-guides
One-click install
npx skills add https://github.com/rodacato/kwik-e-dev --skill contributing-rodacato
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: contributing
Source: https://github.com/rodacato/kwik-e-dev/tree/main/plugins/launchpad/skills/contributing
Command: npx skills add https://github.com/rodacato/kwik-e-dev --skill contributing-rodacato

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Create or update CONTRIBUTING.md — the contributor's runbook. Dev environment setup, branch naming conventions, commit conventions, how to open a PR, code style, and testing expectations. If a new contributor can't clone, set up, run tests, and open their first PR using only this file, it has failed its job.

Core Features & Use Cases

  • Provides a structured process to create or update CONTRIBUTING.md at the project root.
  • Guides establishing prerequisites, dev environment setup, tests, branch/commit conventions, PR workflow, and issue reporting.
  • Helps onboarding contributors and reduces repetitive questions by documenting standards and expectations.

Quick Start

Create or update CONTRIBUTING.md at the project root following the steps outlined in this guide.

Frequently Asked Questions about contributing

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

FAQPage Schema
How do I create a contributor guide for an open-source project?▼

To create a contributor guide, draft a CONTRIBUTING.md file at your project root documenting dev environment setup, branch naming, commit conventions, PR workflow, and testing expectations to standardize onboarding for new contributors.

What should be included in a CONTRIBUTING.md file?▼

A CONTRIBUTING.md file should include prerequisites, dev environment setup, running tests, branch and commit conventions, opening a PR, code review, reporting issues, and when applicable, a code of conduct or CLA/DCO section.

How do I standardize pull request workflow and branch naming conventions for my team?▼

Standardize pull request workflow and branch naming by documenting explicit conventions inside a contributor guide, ensuring all team members follow identical commit and PR steps before submitting code changes.

When do I need to update an existing contributor guide?▼

Update your contributor guide when onboarding questions become repetitive, or when internal AGENTS.md or README guidance exists but external-facing instructions for setting up the dev environment and running tests are missing.

Can I use a contributor guide for internal projects instead of open-source repositories?▼

Yes, you can apply a contributor guide to internal projects. It establishes the same structured layout for dev setup, testing expectations, and code review workflows to streamline internal team onboarding.

What is the best way to reduce repetitive onboarding questions from new developers?▼

The best way to reduce repetitive onboarding questions is maintaining a clear CONTRIBUTING.md runbook. If new contributors cannot clone, set up, run tests, and open their first PR using only this file, it requires updates.

Related Skills

Explore More Software Engineering Skills→
kkestellkkestell
1

kinit

Generate an AGENTS.md file documenting project components, commands, and conventions.

Community
Intermediate
genesis-agentsgenesis-agents
2

Git Workflow

Implement Git workflow conventions and CI checks for GenesisPod projects.

Community
Intermediate
grant-vinegrant-vine
1

oss-licensing-advisor

Audit OSS licenses with SPDX mapping and compatibility risk scoring.

Community
Advanced
robotijnrobotijn
3

onboarding-validator

Audit developer onboarding workflows for setup friction and documentation gaps.

Community
Advanced