github-contributor

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

GitHub Contributor

GitHub贡献者

Strategic guide for becoming an effective GitHub contributor and building your open-source reputation.

成为高效GitHub贡献者并建立开源声誉的策略指南。

The Strategy

策略

Core insight: Many open-source projects have room for improvement. By contributing high-quality PRs, you:

Build contributor reputation
Learn from top codebases
Expand professional network
Create public proof of skills

核心见解：许多开源项目都有改进空间。通过贡献高质量PR，你可以：

建立贡献者声誉
从顶级代码库中学习
拓展职业人脉
创建技能的公开证明

Contribution Types

贡献类型

1. Documentation Improvements

1. 文档改进

Lowest barrier, high impact.

Fix typos, grammar, unclear explanations
Add missing examples
Improve README structure
Translate documentation

Opportunity signals:
- "docs", "documentation" labels
- Issues asking "how do I..."
- Outdated screenshots or examples

门槛最低，影响力高。

修复拼写错误、语法问题和模糊的解释
添加缺失的示例
优化README结构
翻译文档

Opportunity signals:
- "docs", "documentation" labels
- Issues asking "how do I..."
- Outdated screenshots or examples

2. Code Quality Enhancements

2. 代码质量提升

Medium effort, demonstrates technical skill.

Fix linter warnings
Add type annotations
Improve error messages
Refactor for readability

Opportunity signals:
- "good first issue" label
- "tech debt" or "refactor" labels
- Code without tests

中等投入，展现技术能力。

修复代码检查器警告
添加类型注解
优化错误提示信息
重构以提升可读性

Opportunity signals:
- "good first issue" label
- "tech debt" or "refactor" labels
- Code without tests

3. Bug Fixes

3. Bug修复

High impact, builds trust.

Reproduce and fix reported bugs
Add regression tests
Document root cause

Opportunity signals:
- "bug" label with reproduction steps
- Issues with many thumbs up
- Stale bugs (maintainers busy)

影响力高，建立信任。

复现并修复已报告的Bug
添加回归测试
记录根本原因

Opportunity signals:
- "bug" label with reproduction steps
- Issues with many thumbs up
- Stale bugs (maintainers busy)

4. Feature Additions

4. 功能新增

Highest effort, highest visibility.

Implement requested features
Add integrations
Performance improvements

Opportunity signals:
- "help wanted" label
- Features with clear specs
- Issues linked to roadmap

投入最高，曝光度最高。

实现需求的功能
添加集成
性能优化

Opportunity signals:
- "help wanted" label
- Features with clear specs
- Issues linked to roadmap

Project Selection

项目选择

Good First Projects

适合入门的项目

Criteria	Why
Active maintainers	PRs get reviewed
Clear contribution guide	Know expectations
"good first issue" labels	Curated entry points
Recent merged PRs	Project is alive
Friendly community	Supportive feedback

标准	原因
活跃的维护者	PR会得到审核
清晰的贡献指南	了解预期要求
"good first issue"标签	精心筛选的入门切入点
近期有合并的PR	项目仍在活跃
友好的社区	提供支持性反馈

Red Flags

红色预警

No activity in 6+ months
Many open PRs without review
Hostile issue discussions
No contribution guidelines

6个月以上无活动
许多未审核的开放PR
充满敌意的议题讨论
没有贡献指南

Finding Projects

查找项目

bash

undefined

bash

undefined

GitHub search for good first issues

gh search issues "good first issue" --language=python --sort=created

Search by topic

gh search repos "topic:cli" --sort=stars --limit=20

Find repos you use

Check dependencies in your projects

undefined

undefined

PR Excellence

PR卓越实践

Before Writing Code

编写代码前

Pre-PR Checklist:
- [ ] Read CONTRIBUTING.md
- [ ] Check existing PRs for similar changes
- [ ] Comment on issue to claim it
- [ ] Understand project conventions
- [ ] Set up development environment

Pre-PR Checklist:
- [ ] Read CONTRIBUTING.md
- [ ] Check existing PRs for similar changes
- [ ] Comment on issue to claim it
- [ ] Understand project conventions
- [ ] Set up development environment

Writing the PR

编写PR

Title: Clear, conventional format

feat: Add support for YAML config files
fix: Resolve race condition in connection pool
docs: Update installation instructions for Windows
refactor: Extract validation logic into separate module

Description: Structured and thorough

markdown

undefined

标题：清晰、符合规范的格式

feat: Add support for YAML config files
fix: Resolve race condition in connection pool
docs: Update installation instructions for Windows
refactor: Extract validation logic into separate module

描述：结构化且详尽

markdown

undefined

Summary

[What this PR does in 1-2 sentences]

Motivation

[Why this change is needed]

Changes

[Change 1]
[Change 2]

[Change 1]
[Change 2]

Testing

[How you tested this]

Screenshots (if UI)

[Before/After images]

undefined

[Before/After images]

undefined

After Submitting

提交后

Respond to feedback promptly
Make requested changes quickly
Be grateful for reviews
Don't argue, discuss

及时回应反馈
快速做出要求的修改
感谢审核
不要争论，而是讨论

Building Reputation

建立声誉

The Contribution Ladder

贡献阶梯

Level 1: Documentation fixes
    ↓ (build familiarity)
Level 2: Small bug fixes
    ↓ (understand codebase)
Level 3: Feature contributions
    ↓ (trusted contributor)
Level 4: Maintainer status

Level 1: Documentation fixes
    ↓ (build familiarity)
Level 2: Small bug fixes
    ↓ (understand codebase)
Level 3: Feature contributions
    ↓ (trusted contributor)
Level 4: Maintainer status

Consistency Over Volume

持续稳定胜于数量

❌ 10 PRs in one week, then nothing
✅ 1-2 PRs per week, sustained

❌ 10 PRs in one week, then nothing
✅ 1-2 PRs per week, sustained

Engage Beyond PRs

超越PR的参与

Answer questions in issues
Help triage bug reports
Review others' PRs (if welcome)
Join project Discord/Slack

在议题中回答问题
帮助分类错误报告
审核他人的PR（如果允许）
加入项目的Discord/Slack社区

Common Mistakes

常见错误

Don't

不要做

Submit drive-by PRs without context
Argue with maintainers
Ignore code style guidelines
Make massive changes without discussion
Ghost after submitting

提交无上下文的即兴PR
与维护者争论
忽略代码风格指南
未经讨论就进行大规模修改
提交后失联

Do

要做

Start with small, focused PRs
Follow project conventions exactly
Communicate proactively
Accept feedback gracefully
Build relationships over time

从小型、聚焦的PR开始
严格遵循项目规范
主动沟通
优雅地接受反馈
逐步建立关系

Workflow Template

工作流模板

Contribution Workflow:
- [ ] Find project with "good first issue"
- [ ] Read contribution guidelines
- [ ] Comment on issue to claim
- [ ] Fork and set up locally
- [ ] Make focused changes
- [ ] Test thoroughly
- [ ] Write clear PR description
- [ ] Respond to review feedback
- [ ] Celebrate when merged! 🎉

Contribution Workflow:
- [ ] Find project with "good first issue"
- [ ] Read contribution guidelines
- [ ] Comment on issue to claim
- [ ] Fork and set up locally
- [ ] Make focused changes
- [ ] Test thoroughly
- [ ] Write clear PR description
- [ ] Respond to review feedback
- [ ] Celebrate when merged! 🎉

Quick Reference

快速参考

GitHub CLI Commands

GitHub CLI命令

bash

undefined

bash

undefined

Fork a repo

gh repo fork owner/repo --clone

Create PR

gh pr create --title "feat: ..." --body "..."

Check PR status

gh pr status

View project issues

gh issue list --repo owner/repo --label "good first issue"

undefined

gh issue list --repo owner/repo --label "good first issue"

undefined

Commit Message Format

提交消息格式

<type>(<scope>): <description>

[optional body]

[optional footer]

Types:

feat

fix

docs

style

refactor

test

chore

<type>(<scope>): <description>

[optional body]

[optional footer]

类型：

feat

fix

docs

style

refactor

test

chore

References

参考资料

```
references/pr_checklist.md
```
- Complete PR quality checklist
```
references/project_evaluation.md
```
- How to evaluate projects
```
references/communication_templates.md
```
- Issue/PR templates

```
references/pr_checklist.md
```
- 完整的PR质量检查清单
```
references/project_evaluation.md
```
- 项目评估方法
```
references/communication_templates.md
```
- 议题/PR模板