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 python/proofreaders team #1229

Merged
merged 1 commit into from
Feb 6, 2024

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Nov 18, 2023

Fixes #886.

Add the last paragraph here:

image

📚 Documentation preview 📚: https://cpython-devguide--1229.org.readthedocs.build/documentation/help-documenting/#proofreading

Comment on lines +87 to 95
For help with the finer points of English technical writing, mention the
`@python/proofreaders <https://github.com/orgs/python/teams/proofreaders>`__
team in your issue or pull request in any `@python <https://github.com/python/>`__
repo. If you'd like to join the team,
`open a core-workflow issue <https://github.com/python/core-workflow/issues/new/choose>`__
similar to
`python/core-workflow#461 <https://github.com/python/core-workflow/issues/461>`__.

.. _issue tracker: https://github.com/python/cpython/issues
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For help with the finer points of English technical writing, mention the
`@python/proofreaders <https://github.com/orgs/python/teams/proofreaders>`__
team in your issue or pull request in any `@python <https://github.com/python/>`__
repo. If you'd like to join the team,
`open a core-workflow issue <https://github.com/python/core-workflow/issues/new/choose>`__
similar to
`python/core-workflow#461 <https://github.com/python/core-workflow/issues/461>`__.
.. _issue tracker: https://github.com/python/cpython/issues
For help with the finer points of English technical writing, mention the
`@python/proofreaders`_ team in your issue or pull request in any `@python`_ repo.
If you'd like to join the team, `open a core-workflow issue <proofreaders-issue>`_.
.. _issue tracker: https://github.com/python/cpython/issues
.. _@python/proofreaders: https://github.com/orgs/python/teams/proofreaders
.. _@python: https://github.com/python/
.. _proofreaders-issue: https://github.com/python/core-workflow/issues/new?assignees=&labels=&projects=&template=proofreader_membership.md&title=Request+for+Python+Proofreaders+team+membership%3A+name

I updated the link to the new template and moved it at the end together with the others. I hope I got the syntax right 🙃

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question, asked at #886 (comment)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Answer:

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

#886 (comment)

So nothing to mention right now.

@ambv ambv merged commit ce77c74 into python:main Feb 6, 2024
5 checks passed
@hugovk hugovk deleted the document-proofreading-team branch February 6, 2024 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the @proofreaders team
3 participants