An Introduction to Open-Source CollaborationAn Introduction to Open-Source Collaboration

What will you learn in this article?What will you learn in this article?

After reading this chapter, you will master the complete process and etiquette of open source collaboration, and have the confidence to submit contributions to any open source project.After reading this chapter, you will master the complete process and etiquette of open source collaboration, and have the confidence to submit contributions to any open source project.

------

0. The Big Picture: The Value of Open Source0. The Big Picture: The Value of Open Source

Open source is more than code sharing — it's a global collaboration model. Linux, React, Vue, Node.js — these world-changing projects are all open source.Open source is more than code sharing — it's a global collaboration model. Linux, React, Vue, Node.js — these world-changing projects are all open source.

------

1. Open Source Contribution Process1. Open Source Contribution Process

Use the interactive component below to step through the complete process from Fork to Merge:Use the interactive component below to step through the complete process from Fork to Merge:

1.1 Process Overview1.1 Process Overview

Fork → Clone → Branch → Commit → Push → PR → Review → Merge

1.2 Key Steps in Detail1.2 Key Steps in Detail

Create a feature branch: Never develop directly on main.Create a feature branch: Never develop directly on main.

git checkout -b fix/typo-in-readme

Write clear commit messages: Follow the project's commit conventions.Write clear commit messages: Follow the project's commit conventions.

git commit -m "fix: correct typo in README install command"

Create a Pull Request: The PR description should include:Create a Pull Request: The PR description should include:

• What changed and whyWhat changed and why
• Related issue number (e.g., Fixes #123)Related issue number (e.g., Fixes #123)
• How to test your changesHow to test your changes

------

2. Open Source Licenses2. Open Source Licenses

Use the interactive component below to compare common open source licenses:Use the interactive component below to compare common open source licenses:

2.1 Common Licenses2.1 Common Licenses

2.2 Approach to choosing2.2 Approach to choosing

• Want more people to use it: Choose MITWant more people to use it: Choose MIT
• Want to protect patents: Choose Apache 2.0Want to protect patents: Choose Apache 2.0
• Want to ensure derivatives stay open source: Choose GPLWant to ensure derivatives stay open source: Choose GPL

------

3. Collaboration Etiquette3. Collaboration Etiquette

3.1 Etiquette for Filing Issues3.1 Etiquette for Filing Issues

<!-- Bad --> Title: It doesn't work Content: Your stuff has bugs <!-- Good --> Title: v2.1.0 login page shows white screen on Safari 17 Content: - Environment: macOS 14.2, Safari 17.2 - Steps to reproduce: 1. Open login page 2. Enter credentials 3. Click login - Expected behavior: Redirect to home page - Actual behavior: White screen, console error TypeError: xxx - Screenshot: [attached]

3.2 Etiquette for Submitting PRs3.2 Etiquette for Submitting PRs

• Read CONTRIBUTING.md first to understand the project's contribution guidelinesRead CONTRIBUTING.md first to understand the project's contribution guidelines
• One PR should do one thing only — don't mix multiple changesOne PR should do one thing only — don't mix multiple changes
• Keep PRs small and focused for easier reviewKeep PRs small and focused for easier review
• Be patient waiting for review and respond to feedback politelyBe patient waiting for review and respond to feedback politely

3.3 Reviewing Others' Code3.3 Reviewing Others' Code

• Acknowledge what's done well first, then suggest improvementsAcknowledge what's done well first, then suggest improvements
• Ask rather than command: "Have you considered using approach X here?"Ask rather than command: "Have you considered using approach X here?"
• Give reasons and alternatives, not just "not good"Give reasons and alternatives, not just "not good"

------

4. Contributing from Scratch4. Contributing from Scratch

4.1 Beginner-Friendly Contribution Types4.1 Beginner-Friendly Contribution Types

4.2 Finding the Right Project4.2 Finding the Right Project

• Start with tools you use dailyStart with tools you use daily
• Search for good first issue labels on GitHubSearch for good first issue labels on GitHub
• Check project activity (are there recent maintainers?)Check project activity (are there recent maintainers?)

------

5. AI-Powered: Using LLMs to Accelerate Open Source Contributions5. AI-Powered: Using LLMs to Accelerate Open Source Contributions

LLMs can help you quickly understand unfamiliar codebases, write high-quality PR descriptions, and even assist with code reviews.LLMs can help you quickly understand unfamiliar codebases, write high-quality PR descriptions, and even assist with code reviews.

5.1 Quickly Understanding Unfamiliar Codebases5.1 Quickly Understanding Unfamiliar Codebases

> Prompt:> Prompt:

> ```> ```

> I just cloned an open source project. Please analyze the following> I just cloned an open source project. Please analyze the following

> directory structure, explain the responsibility of each directory/file,> directory structure, explain the responsibility of each directory/file,

> and describe the overall architecture and data flow.> and describe the overall architecture and data flow.

> I want to fix a login-related bug — where should I start looking?> I want to fix a login-related bug — where should I start looking?

>>

> [Paste tree command output or directory structure]> [Paste tree command output or directory structure]

> ```> ```

5.2 Writing PR Descriptions5.2 Writing PR Descriptions

> Prompt:> Prompt:

> ```> ```

> Based on the following git diff, write a Pull Request description including:> Based on the following git diff, write a Pull Request description including:

> - Title (concise, stating what changed)> - Title (concise, stating what changed)

> - Change description (why and what changed)> - Change description (why and what changed)

> - Testing method (how to verify the change is correct)> - Testing method (how to verify the change is correct)

> - Related issue (if any)> - Related issue (if any)

> Write in English with a professional and friendly tone.> Write in English with a professional and friendly tone.

>>

> [Paste git diff output]> [Paste git diff output]

> ```> ```

5.3 Assisting with Document Translation5.3 Assisting with Document Translation

> Prompt:> Prompt:

> ```> ```

> Translate the following Chinese technical document into English, with these requirements:> Translate the following Chinese technical document into English, with these requirements:

> 1. Use industry-standard English expressions for technical terms> 1. Use industry-standard English expressions for technical terms

> 2. Do not translate code comments and variable names> 2. Do not translate code comments and variable names

> 3. Keep Markdown formatting unchanged> 3. Keep Markdown formatting unchanged

> 4. Natural and fluent tone, not machine-translated> 4. Natural and fluent tone, not machine-translated

>>

> [Paste Chinese document]> [Paste Chinese document]

> ```> ```

------

6. Summary6. Summary

1. Process: Fork → Branch → Commit → PR → Review → MergeProcess: Fork → Branch → Commit → PR → Review → Merge
2. Licenses: MIT is most permissive, GPL is most strict — choose based on your needsLicenses: MIT is most permissive, GPL is most strict — choose based on your needs
3. Etiquette: Clear issues, focused PRs, polite communicationEtiquette: Clear issues, focused PRs, polite communication
4. Getting Started: Start with documentation fixes and good first issue labelsGetting Started: Start with documentation fixes and good first issue labels
💡 Tips Praktis💡 Pro Tip

The essence of open source is collaboration. Technical skills are important, but communication skills and collaboration awareness are equally crucial. A friendly, well-described PR is more welcome than a perfectly coded but rudely communicated one. Your first PR doesn't need to be perfect — it just needs to be your first step.The essence of open source is collaboration. Technical skills are important, but communication skills and collaboration awareness are equally crucial. A friendly, well-described PR is more welcome than a perfectly coded but rudely communicated one. Your first PR doesn't need to be perfect — it just needs to be your first step.

------

Further ReadingFurther Reading

• Getting Started Guide: GitHub's Open Source Guide is the best resource for open source beginners.Getting Started Guide: GitHub's Open Source Guide is the best resource for open source beginners.
• Practical Advice: Find a project you like, star it first, then read the code, and eventually find an opportunity to contribute.Practical Advice: Find a project you like, star it first, then read the code, and eventually find an opportunity to contribute.
• Community Participation: Join open source events like Hacktoberfest for community support.Community Participation: Join open source events like Hacktoberfest for community support.
• Maintainer's Perspective: Understand the workload and pressure of maintainers — be a considerate contributor.Maintainer's Perspective: Understand the workload and pressure of maintainers — be a considerate contributor.
← SebelumnyaPrevious9-engineering-excellence/design-patterns9-engineering-excellence/design-patterns SelanjutnyaNext →9-engineering-excellence/security-thinking9-engineering-excellence/security-thinking