Skip to content

Commit 67abb28

Browse files
Copilotmekarpeles
andcommitted
Split CONTRIBUTING.md into CONTRIBUTING.md and MAINTAINERS.md with contributor etiquette
Co-authored-by: mekarpeles <978325+mekarpeles@users.noreply.github.com>
1 parent d347857 commit 67abb28

File tree

2 files changed

+38
-21
lines changed

2 files changed

+38
-21
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,23 @@ Refer to the [wiki](https://github.com/internetarchive/openlibrary/wiki) for mor
8080

8181
[Here's a list of good first issues](https://github.com/internetarchive/openlibrary/issues?q=is%3Aissue+is%3Aopen+-linked%3Apr+label%3A%22Good+First+Issue%22+no%3Aassignee) to help you get started. Please only pick issues that are not assigned to anyone, or if an issue has been assigned but has seen no response or activity for 2 weeks. Do not request to be assigned to issues that are actively being worked on. If you're interested in working on an issue without an assignee or one that has been inactive, comment on it to ask if you can be assigned. If you have questions, please ask the [Lead](https://github.com/internetarchive/openlibrary/wiki/Using-Managed-Labels-to-Track-Issues#triage) designated by the `Lead: @person` label on the issue.
8282

83+
## Contributor Etiquette
84+
85+
We value all contributors and want to ensure a positive and collaborative environment. Please follow these guidelines:
86+
87+
### Respecting Other Contributors' Work
88+
- **Do not undermine others' efforts**: If someone has already asked to work on an issue and been assigned (or is actively working on it), please respect their effort. Opening a competing PR without coordination undermines their contribution and violates our community spirit.
89+
- **Check before starting**: Before beginning work on an issue, check if someone else is already assigned or has recently expressed interest in working on it.
90+
91+
### Requesting Issue Assignments
92+
- **Quality over quantity**: Please do not ask to be assigned to dozens of issues at a time. Focus on making meaningful contributions rather than accumulating assignments.
93+
- **Demonstrate understanding**: When requesting to be assigned to an issue, show that you understand the problem by including:
94+
- A summary of the challenge or bug
95+
- Your proposed approach to solving it
96+
- Which files or components you plan to modify
97+
- Any questions you have about the implementation
98+
- **Use AI tools responsibly**: While you're encouraged to use AI tools (like LLMs) to assist with research and understanding the codebase, please don't simply copy-paste AI-generated responses into your comments. Take time to understand the suggestions and present them in your own words, demonstrating genuine comprehension of the issue.
99+
83100
### Our Roadmap(s)
84101
You can see this year (and previous year's) roadmap(s) [here](https://docs.google.com/document/d/1KJr3A81Gew7nfuyo9PnCLCjNBDs5c7iR4loOGm1Pafs/edit).
85102

@@ -137,24 +154,3 @@ Follow these rules when creating a PR:
137154
4. **Resolve all code review (CR) comments**: Treat comments as a todo list. Most PRs will require some edits before getting merged, so don't get discouraged if you have to make some changes!
138155
5. **Reply when resolving CR comments**: When resolving a comment, reply with either "DONE" or "WON'T FIX because ...". A reviewer will unresolve a comment if they feel it's necessary.
139156

140-
# Maintainers
141-
142-
Guidelines for repo maintainers.
143-
144-
## Pull Requests
145-
146-
We use assignee to denote PR ownership. If you are the assignee, then you should have the PR on your todo list until you merge or close it.
147-
- **Assign yourself** to a PR if you have the time to take on the responsibilities of ownership (described below).
148-
- **Don't assign others** to a PR. Feel free to ask someone to take ownership, but respect others' time restrictions.
149-
- **Avoid assignee=author**. In the case where the PR author is also a maintainer, we will strive to have another maintainer own and merge the PR to ensure these steps are followed fairly by all.
150-
151-
The assignee of a PR is responsible for:
152-
- **being the primary contact** for the PR author. Be polite; you're the face of the community to this contributor.
153-
- **managing the PR's labels**. Add `Needs: Author Input` or `Needs: Review` as necessary.
154-
- **ensuring the PR doesn't get stuck**. Avoid leaving the author wondering about the state of the PR. If you don't have time right now, saying "I'm a little swamped now but will try to get to this in \_" is better than radio silence for a week.
155-
- **getting the PR code reviewed** either by yourself (often so) or by someone else.
156-
- **getting merge approval**. If a PR requires a special deploy, label as `Needs: Deploy Approval` and get that approval before merging.
157-
- **testing the PR** before merging. Comment about how you tested in the PR. If _any_ changes are made to the PR code, you will have to test it again before merging.
158-
- **merging (or closing)** the PR.
159-
160-
Each Monday (as of 2022) we triage PRs (excluding drafts) and make sure they have leads assigneed so that nothing gets stuck.

MAINTAINERS.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Maintainers
2+
3+
Guidelines for repo maintainers.
4+
5+
## Pull Requests
6+
7+
We use assignee to denote PR ownership. If you are the assignee, then you should have the PR on your todo list until you merge or close it.
8+
- **Assign yourself** to a PR if you have the time to take on the responsibilities of ownership (described below).
9+
- **Don't assign others** to a PR. Feel free to ask someone to take ownership, but respect others' time restrictions.
10+
- **Avoid assignee=author**. In the case where the PR author is also a maintainer, we will strive to have another maintainer own and merge the PR to ensure these steps are followed fairly by all.
11+
12+
The assignee of a PR is responsible for:
13+
- **being the primary contact** for the PR author. Be polite; you're the face of the community to this contributor.
14+
- **managing the PR's labels**. Add `Needs: Author Input` or `Needs: Review` as necessary.
15+
- **ensuring the PR doesn't get stuck**. Avoid leaving the author wondering about the state of the PR. If you don't have time right now, saying "I'm a little swamped now but will try to get to this in \_" is better than radio silence for a week.
16+
- **getting the PR code reviewed** either by yourself (often so) or by someone else.
17+
- **getting merge approval**. If a PR requires a special deploy, label as `Needs: Deploy Approval` and get that approval before merging.
18+
- **testing the PR** before merging. Comment about how you tested in the PR. If _any_ changes are made to the PR code, you will have to test it again before merging.
19+
- **merging (or closing)** the PR.
20+
21+
Each Monday (as of 2022) we triage PRs (excluding drafts) and make sure they have leads assigneed so that nothing gets stuck.

0 commit comments

Comments
 (0)