返回 Skill 列表
extension
分类: 开发与工程无需 API Key

oss-contribution-framework

为开源项目做贡献的系统框架。指导你从问题发现、结合代码探索的综合分析、实现到创建PR的过程。在开始OSS贡献、分析问题或创建拉取请求时使用。包括每个贡献阶段的模块化子技能。

person作者: jakexiaohubgithub

OSS Contribution Framework

A comprehensive, step-by-step framework for making meaningful open source contributions. This skill orchestrates the entire contribution workflow from finding the right issue to submitting a polished pull request.

Overview

This framework breaks down OSS contributions into four systematic phases, each with its own dedicated sub-skill. You can use the complete workflow or invoke individual phases as needed.

Quick Start

Full workflow:

사용자: "이 프로젝트에 기여하고 싶어" or "OSS 기여 시작"
→ Framework guides through all 4 phases

Individual phase:

사용자: "이슈 분석해줘" or "코드 구현"
→ Activates specific sub-skill

Four-Phase Workflow

Phase 1: Issue Discovery & Triage

Sub-skill: skills/issue-discovery.md

Find and evaluate suitable issues to work on.

Capabilities:

  • Filter issues by labels, difficulty, project activity
  • Assess issue quality and clarity
  • Evaluate if issue matches your skills
  • Check for duplicate work or stale issues

Triggers:

  • "좋은 이슈 찾아줘"
  • "beginner-friendly 이슈 추천"
  • "이 이슈가 적합한지 평가해줘"

Phase 2: Issue Analysis & Code Exploration

Sub-skill: skills/issue-analysis.md

INTEGRATED PHASE - Deep analysis combining requirements extraction with codebase exploration and code-level mapping.

Capabilities:

  • Extract core requirements and acceptance criteria
  • Explore project structure and conventions
  • Locate exact files and functions to modify
  • Identify problem code and fix points
  • Trace execution paths
  • Map dependencies and impact
  • Plan specific code modifications

Triggers:

  • "이 이슈 분석해줘"
  • "코드에서 어디를 고쳐야 하나?"
  • "이슈와 코드 연결"
  • "문제 있는 코드 찾기"

Phase 3: Solution Implementation

Sub-skill: skills/solution-implementation.md

Design and implement the solution following project standards.

Capabilities:

  • Design solution approach
  • Write code following project conventions
  • Add/update tests
  • Handle edge cases

Triggers:

  • "솔루션 구현"
  • "이슈 해결 시작"
  • "테스트 작성"

Phase 4: Documentation & PR

Sub-skill: skills/documentation-pr.md

Document changes and create a comprehensive pull request.

Capabilities:

  • Write clear PR description
  • Document code changes
  • Create changelog entries
  • Prepare for review

Triggers:

  • "PR 작성"
  • "문서화"
  • "pull request 준비"

Workflow Orchestration

The main framework manages state and progress across phases:

Initial Setup

When user starts contribution workflow:

  1. Detect starting point:

    • New contribution: Start at Phase 1
    • Have issue URL: Start at Phase 2
    • Already analyzed: Start at Phase 3
    • Ready to implement: Start at Phase 5
  2. Gather context:

    • Repository URL or local path
    • Issue number/URL (if available)
    • User's familiarity with project
    • Language/framework preferences
  3. Initialize tracker:

## 🎯 Contribution Progress
- [ ] Phase 1: Issue Discovery
- [ ] Phase 2: Issue Analysis & Code Exploration
- [ ] Phase 3: Solution Implementation
- [ ] Phase 4: Documentation & PR

**Current Phase:** [PHASE]
**Repository:** [REPO]
**Issue:** [ISSUE_URL]

Phase Transitions

After completing each phase, checkpoint with user:

"Phase [N] 완료했습니다.

[SUMMARY OF FINDINGS]

다음 단계:
1. Phase [N+1] 진행 - [DESCRIPTION]
2. 현재 단계 심화 분석
3. 특정 부분 재검토

어떻게 진행할까요?"

Progressive Context

Maintain and carry forward context between phases:

  • Phase 1 → 2: Issue URL, labels, initial assessment, CONTRIBUTING.md requirements
  • Phase 2 → 3: Requirements, project structure, exact code locations, modification plan
  • Phase 3 → 4: Implementation changes, tests added, commits made

Sub-Skill Invocation

Each sub-skill can be invoked independently or as part of the workflow.

Independent usage:

사용자: "이 이슈 분석해줘: https://github.com/..."
→ Directly loads Phase 2 sub-skill

Within workflow:

Framework: "Phase 2를 시작합니다..."
→ Internally loads skills/issue-analysis.md
→ Applies guidance and returns results
→ Updates progress tracker

Adaptive Guidance

The framework adapts based on:

Project type:

  • Web app: Focus on UI/UX, API, state management
  • CLI tool: Focus on commands, flags, I/O
  • Library: Focus on API design, backwards compatibility
  • Documentation: Focus on clarity, examples, accuracy

Issue type:

  • Bug: Root cause analysis, reproduction steps
  • Feature: Design considerations, API surface
  • Refactor: Code quality, test coverage maintenance
  • Docs: Accuracy, completeness, examples

User experience level:

  • First contribution: More guidance, explanations
  • Experienced: Streamlined, focus on project-specific aspects

Best Practices

For optimal results:

  1. Start early - Engage framework before coding
  2. Be thorough - Don't skip phases, especially exploration
  3. Communicate - Comment on issue before starting work
  4. Test locally - Verify changes before PR
  5. Follow conventions - Match project style strictly
  6. Ask questions - Engage maintainers when unclear

Quality checklist:

Before moving to Phase 4 (PR), verify:

  • [ ] All requirements addressed
  • [ ] Tests pass locally
  • [ ] Code follows project conventions
  • [ ] No unintended changes
  • [ ] Documentation updated
  • [ ] Commit messages are clear

Advanced Features

Multi-Issue Analysis

Compare and prioritize multiple issues:

"이 3개 이슈 중 어떤 걸 먼저 해야 할까?"
→ Analyzes difficulty, impact, learning value

Contribution Strategy

Get personalized contribution roadmap:

"이 프로젝트에 장기적으로 기여하고 싶어"
→ Suggests progression path from simple to complex issues

Review Preparation

Prepare for code review:

"PR 리뷰 대비"
→ Anticipates reviewer questions and concerns

Reference Materials

Each phase has detailed references:

  • references/issue-patterns.md - Common issue types and approaches
  • references/codebase-checklist.md - Systematic exploration guide
  • references/pr-templates.md - Template library for various projects
  • references/contribution-tips.md - Project-specific guidelines

Templates

Standard output templates in assets/templates/:

  • issue-analysis-template.md - Structured issue breakdown
  • codebase-notes-template.md - Project understanding notes
  • pr-checklist-template.md - Pre-submission checklist

Notes

  • This framework is language and project-agnostic
  • Adapt guidance to specific project conventions
  • Always prioritize maintainer preferences
  • Focus on sustainable, long-term contributions
  • Build understanding, not just code changes

Progressive Disclosure

  1. Start here - SKILL.md for overview and workflow
  2. Load sub-skills - Individual phase guidance as needed
  3. Consult references - Detailed patterns and checklists
  4. Use templates - Structured output formats