devguide icon indicating copy to clipboard operation
devguide copied to clipboard

Published 20 hours ago • verified publisher icon python

Document the @proofreaders team

Open encukou opened this issue 2 years ago • 3 comments

  • 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?

encukou avatar Jun 07 '22 11:06 encukou

We should probably add a section/page to document the existing teams, their purpose, and the process to join them. This came up in https://github.com/python/core-workflow/issues/458#issuecomment-1148558930 too.

ezio-melotti avatar Jun 07 '22 12:06 ezio-melotti

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.

CAM-Gerlach avatar Jun 08 '22 01:06 CAM-Gerlach

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

ezio-melotti avatar Jul 13 '22 01:07 ezio-melotti

Please see PR #1229.

hugovk avatar Nov 18 '23 15:11 hugovk

A question from https://github.com/python/devguide/pull/1229#discussion_r1400017282:

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.

hugovk avatar Nov 21 '23 06:11 hugovk

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

encukou avatar Jan 03 '24 07:01 encukou