ronantakizawa/open-source-contribution

Overview

This skill guides developers through practical open source contribution workflows, from finding suitable projects to writing high-quality pull requests and communicating with maintainers. It covers commit conventions, branch strategies, enterprise standards, and responsible security disclosure. The goal is to help contributors produce reviewable, maintainable work that maintainers can merge quickly.

How this skill works

The skill inspects your contribution scenario and provides step-by-step guidance: how to evaluate a project, prepare a local dev environment, structure branches and commits, and craft PR descriptions. It also offers templates and response phrasing for code review and maintainers, plus checks and reminders for common pitfalls like secrets, CI failures, and oversized PRs. Enterprise and security disclosure practices are included for high-stakes contributions.

When to use it

• You want to find a beginner-friendly or high-impact issue to work on.
• Preparing a fork/branch and writing a pull request for GitHub or GitLab.
• Composing conventional commit messages and PR descriptions.
• Responding to code review feedback or re-requesting review.
• Reporting a security vulnerability or following enterprise disclosure procedures.

Best practices

• Read README, CONTRIBUTING, and architecture docs before coding.
• Create small, single-concern PRs (ideally <200 lines) and include tests.
• Use conventional commits and clear branch naming (type/short-description).
• Claim issues before coding and keep communication public and concise.
• Run CI locally, remove secrets/debugging code, and self-review diffs.

Example use cases

• Finding 'good first issue' labels and evaluating project activity before starting.
• Forking a repo, syncing upstream, creating a feature branch, and opening a PR from the fork.
• Writing a commit that follows Conventional Commits and references the issue it fixes.
• Responding calmly to reviewer comments with an agreed change, clarification, or follow-up PR plan.
• Preparing a responsible security report using disclosure best practices.