You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: github-git/github-social-platform.md
+5-18Lines changed: 5 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,10 @@ kernelspec:
13
13
14
14
# Community Interaction Best Practices on GitHub
15
15
16
+
🚧 These lessons are under heavy construction and will continue to change through March 2025 🚧
16
17
## Introduction
17
18
18
-
GitHub is more than just a platform for hosting code—it’s a **social platform** where developers, researchers, and contributors work together to create, improve, and share projects. Behind every username is a person who deserves respect and appreciation.
19
+
GitHub is more than just a platform for hosting code—it’s a **social platform** where developers, researchers, and contributors work together to create, improve, and share projects. Behind every username is a person who deserves respect and appreciation.
19
20
20
21
This lesson will teach you how to interact constructively and positively within the GitHub community. Whether submitting an issue, reviewing someone else’s work, or asking for help, following these best practices will help you collaborate effectively and maintain a welcoming environment.
21
22
@@ -24,19 +25,16 @@ This lesson will teach you how to interact constructively and positively within
24
25
Effective communication on GitHub ensures a productive and respectful collaboration environment. Whether you're raising an issue, reviewing code, or contributing to a discussion, these principles will help you interact constructively.
25
26
26
27
### Respect and professionalism
27
-
28
28
- Treat everyone with respect, even when disagreements arise.
29
29
- Remember that many maintainers and contributors volunteer their time and expertise to the community.
30
30
- Use polite and appreciative language when reaching out or giving feedback.
31
31
_Example: "Thank you for creating this tool. It's been really helpful!"_
32
32
33
33
### Patience
34
-
35
34
- Be understanding if responses to issues or pull requests take time.
36
35
- Open-source maintainers often juggle multiple responsibilities outside their projects.
37
36
38
37
### Clarity and thoughtfulness
39
-
40
38
-**Use clear and concise language**:
41
39
- Clearly describe issues, bugs, or suggestions to avoid confusion.
42
40
- Avoid unnecessary jargon or overcomplicating explanations.
@@ -48,19 +46,19 @@ Effective communication on GitHub ensures a productive and respectful collaborat
48
46
- Use **reactions** (like 👍 or ❤️) to express agreement or appreciation without cluttering threads with “+1” comments.
49
47
50
48
### Constructive feedback
51
-
52
49
- Avoid harsh language, blame, or criticism.
53
50
- Frame suggestions as questions or alternatives:
54
51
_"What if we try this approach?"_ instead of _"This is wrong."_
55
52
- Acknowledge positive aspects alongside suggestions for improvement.
56
53
57
54
:::{todo}
58
-
Move this to the pr page once I create it.
55
+
Move this to the pr page once I create it.
59
56
60
57
## 3. When Contributing to a Repository
61
58
62
-
### Opening Pull Requests
63
59
60
+
61
+
### Opening Pull Requests
64
62
-**Describe the Change**: Clearly explain what you’re proposing and why it’s needed.
65
63
-**Follow Contribution Guidelines**: Adhere to any style or workflow rules outlined in the repository.
66
64
-**Be Open to Feedback**: Expect to receive suggestions for improvement and revise your pull request accordingly.
@@ -78,12 +76,10 @@ Here are key social cues to follow:
78
76
### 1️⃣ Help Maintainers Keep Track of Who’s Working on What
79
77
80
78
<iclass="fa-solid fa-list-check"style="color: #6ec9c3;"></i> **Open an issue first before submitting a PR.**
81
-
82
79
- This prevents duplicate work and ensures the maintainers **know who is working on what**.
83
80
- If an issue already exists, **comment on it** instead of creating a new one.
84
81
85
82
<iclass="fa-solid fa-triangle-exclamation"style="color: #6ec9c3;"></i> **Avoid surprising maintainers with a PR.**
86
-
87
83
- Some projects may not be ready for the change you're suggesting.
88
84
- Opening an issue first allows maintainers to **provide guidance before you start coding**.
89
85
@@ -92,12 +88,10 @@ Here are key social cues to follow:
92
88
### 2️⃣ Respect the Project’s Process
93
89
94
90
<iclass="fa-solid fa-book-open"style="color: #6ec9c3;"></i> **Follow issue templates and contribution guidelines.**
95
-
96
91
- Many projects have structured templates—**use them** to provide all necessary details.
97
92
- If guidelines exist, reference them in your issue to show you're **aligning with their workflow**.
98
93
99
94
<iclass="fa-solid fa-compass-drafting"style="color: #6ec9c3;"></i> **Ask before making major changes.**
100
-
101
95
- If your fix changes functionality, check with maintainers before proceeding.
102
96
- A simple “Would this be useful?” can save **time for both you and the maintainers**.
103
97
@@ -106,12 +100,10 @@ Here are key social cues to follow:
- If you know who maintains the repo, consider **@mentioning them** in your issue to establish a connection.
116
108
- Example: `@maintainer-name, I’d love to help fix this! Any guidance before I start?`
117
109
@@ -120,12 +112,10 @@ Here are key social cues to follow:
120
112
### 4️⃣ Communicate Like You Would in Real Life
121
113
122
114
<iclass="fa-solid fa-comments"style="color: #6ec9c3;"></i> **Be polite and professional.**
123
-
124
115
- Open source is about **collaborating with people you’ve never met**.
125
116
- Treat maintainers **as you would a colleague**—respectful and appreciative of their time.
126
117
127
118
<iclass="fa-solid fa-hand-wave"style="color: #6ec9c3;"></i> **Introduce yourself in your first issue comment.**
128
-
129
119
- If you’re new, a friendly introduction can make it easier to build relationships.
130
120
- Example:
131
121
> “Hey everyone! 👋 I’m new to contributing here and would love to help with this issue. Let me know if there’s anything I should consider before getting started!”
@@ -135,19 +125,16 @@ Here are key social cues to follow:
135
125
### 5️⃣ Build Trust Through Small Contributions
136
126
137
127
<iclass="fa-solid fa-user-check"style="color: #6ec9c3;"></i> **Start small to establish credibility.**
138
-
139
128
- First contributions aren’t just about code—they're about **building trust with the community**.
140
129
-**Small fixes** (like documentation updates or typo corrections) are a great way to get started.
141
130
142
131
<iclass="fa-solid fa-layer-group"style="color: #6ec9c3;"></i> **Contributions add up over time.**
143
-
144
132
- Even small changes **help the project grow** and demonstrate your commitment.
145
133
- Once maintainers recognize your contributions, they’re more likely to engage with your work.
0 commit comments