Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the @proofreaders team #886

Closed
encukou opened this issue Jun 7, 2022 · 6 comments · Fixed by #1229
Closed

Document the @proofreaders team #886

encukou opened this issue Jun 7, 2022 · 6 comments · Fixed by #1229
Assignees
Labels
enhancement guide-new content Additions; New content or section needed topic-documentation

Comments

@encukou
Copy link
Member

encukou commented Jun 7, 2022

  • If you'd like help with English in a Python-related repo (docs, PEPs, devguide, ...), mention @python/proofreaders on GitHub to get their attention
  • If you'd like to join (edited): open an issue on core-workflow similar to #461 .

(I don't know who else has privileges to add members to the team.)

@ezio-melotti, would you like to add this?

@ezio-melotti
Copy link
Member

We should probably add a section/page to document the existing teams, their purpose, and the process to join them. This came up in python/core-workflow#458 (comment) too.

@CAM-Gerlach
Copy link
Member

I might also suggest refining the team description a touch, perhaps along the lines of "Mention [...] for help with the finer points of English technical writing," to avoid sounding like its just for people who need basic help with English and to reduce any shame someone might feel asking us for help. Indeed, while some may need it more and others less, almost anyone's writing could potentially benefit from a second look by a proofreader—English technical writing may happen to be an area of strength for me, but I certainly still make plenty of mistakes and typos, and could word things more clearly.

@ezio-melotti
Copy link
Member

FTR there is also a section in the devguide about proofreading that should mention the team: https://devguide.python.org/documentation/help-documenting/#proofreading

@hugovk
Copy link
Member

hugovk commented Nov 18, 2023

Please see PR #1229.

@hugovk
Copy link
Member

hugovk commented Nov 21, 2023

A question from #1229 (comment):

I was also wondering if there are any restrictions for joining the group -- do people that send requests need to be already part of the python org (e.g. as triagers)? If so, we should mention that too.

Good question! Are there any restrictions?

I guess some of the people in the team (https://github.com/orgs/python/teams/proofreaders) were added to the org to be able to add them to the team.

I don't think future applicants would need to be already in the org, but we should take care in accepting applications.

@encukou
Copy link
Member Author

encukou commented Jan 3, 2024

At the moment, there aren't any restrictions. (Of course, that might change if people start abusing this somehow.)

@ambv ambv closed this as completed in #1229 Feb 6, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in Sprint 2024 Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement guide-new content Additions; New content or section needed topic-documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

5 participants