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: CONTRIBUTING.md
+19-7Lines changed: 19 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# Contributing
2
2
3
-
Thanks for your interest in contributing to Open Library! This guide explains how to choose work, coordinate with maintainers, and submit a pull request successfully. For setup instructions, see the [Quick Start](https://docs.openlibrary.org/developers/quick-start.html) guide.
3
+
Thanks for your interest in contributing to Open Library! We value thoughtful, collaborative contributions. Before picking up work, make sure you understand the problem, check whether someone is already working on it, and coordinate with maintainers so efforts align with project priorities. Good contributions are not just about completing an issue, but about solving the right problem clearly and respectfully.
4
+
5
+
For setup instructions, see the [Quick Start](https://docs.openlibrary.org/developers/quick-start.html) guide.
4
6
5
7
## How contributing works
6
8
@@ -13,17 +15,27 @@ Thanks for your interest in contributing to Open Library! This guide explains ho
13
15
14
16
## Before you begin
15
17
18
+
We value all contributors and want to ensure a positive and collaborative environment where everyone's contributions are respected and celebrated.
19
+
20
+
### Respecting Other Contributors' Work
21
+
22
+
Our community thrives on mutual respect. Please consider others who may already be investing their time and energy:
23
+
24
+
-**Check before starting**: Look at the issue comments to see if someone has already requested assignment or is actively working on it
25
+
-**Respect current assignments**: If someone is assigned to an issue, they've committed their time to it. Opening a competing PR without coordination undermines their contribution
26
+
-**Coordinate when uncertain**: If you're unsure about someone's progress, ask on the issue before starting related work
27
+
-**Give space for follow-through**: If an assigned issue has been inactive for 2 weeks, kindly ask whether it can be reassigned rather than assuming it's abandoned
28
+
### Requesting Issue Assignments
29
+
16
30
Please **request assignment** to an issue before starting work. Our maintainers triage issues weekly (or immediately for high-priority items) to ensure your contribution aligns with current priorities and prevent duplicate effort.
17
31
18
32
When requesting assignment:
19
33
20
-
- Focus on one meaningful issue at a time rather than requesting many
21
-
- Explain the problem and your proposed approach in your own words
22
-
- Mention which files or components you plan to modify
23
-
24
-
**Use AI tools responsibly.** Be prepared to explain the problem and your proposed solution in your own words.
34
+
-**Focus on quality over quantity**: Work on one meaningful issue at a time rather than requesting many assignments
35
+
-**Show you understand the problem**: Include your summary of the challenge, your proposed approach, and which files you plan to modify
36
+
-**Share your questions**: If something isn't clear, ask! This helps us provide better guidance
25
37
26
-
Please respect current assignments. If someone is already assigned or actively working on an issue, coordinate on the issue before starting related work.
38
+
**Use AI tools responsibly.** You're encouraged to use AI tools to assist with research and understanding the codebase, but please take time to truly comprehend the suggestions and present them in your own words. This demonstrates your genuine understanding and helps us have meaningful conversations about your approach.
0 commit comments