diff --git a/docs/conf.py b/docs/conf.py index 607f4f3b0..b6ff4590d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -71,7 +71,7 @@ html_static_path = ["_static"] html_theme = "pydata_sphinx_theme" html_theme_options = { - "announcement": "Until further notice, maintainers alone are unable to respond to the high volume of new pull requests.
See Conduct a peer review instead of opening a new pull request.", # noqa: E501 + "announcement": "Until further notice, maintainers alone are unable to respond to the high volume of new pull requests.
See Peer reviews instead of opening a new pull request.", # noqa: E501 "icon_links": [ { "name": "GitHub", diff --git a/docs/contribute/index.rst b/docs/contribute/index.rst index bdcd39476..70e288a27 100644 --- a/docs/contribute/index.rst +++ b/docs/contribute/index.rst @@ -5,7 +5,7 @@ Contribute .. important:: Until further notice, maintainers alone are unable to respond to the high volume of new pull requests. - To help improve this situation, it's strongly recommended that you :ref:`conduct-a-peer-review` instead of opening a new pull request. + To help improve this situation, it's strongly recommended that you follow :ref:`peer-reviews` instead of opening a new pull request. This guide describes how to contribute to icalendar. @@ -35,7 +35,7 @@ Triage and review - Comment on and resolve issues. - Triage open issues and `pull requests `_. -- :ref:`conduct-a-peer-review`. +- :ref:`Give a peer review `. - Reproduce an issue and add a comment with your findings. Documentation @@ -179,10 +179,10 @@ The maintainers may close pull requests without providing feedback that they dee The maintainers may also take further action, including suspend, ban, or report GitHub users, as described in Python Calendaring Ecosystem's `Code of Conduct `_. -.. _conduct-a-peer-review: +.. _peer-reviews: -Conduct a peer review ---------------------- +Peer reviews +------------ .. important:: @@ -193,6 +193,14 @@ A peer review is when you look at an open pull request of another contributor, a You'll help your colleagues, learn from one another, and gain valuable communication and collaboration skills that every programming job requires. It will also help maintainers handle high priority items in a timely manner, such as addressing security reports, making releases, and conducting final code and documentation reviews. +You can give a peer review to a colleague or request one from a colleague. + +To request a peer review, you can either: + +- Mention your colleague in a comment by typing the ``@`` symbol followed by their username ``@github-username``. +- From the pull request's :guilabel:`Reviewers` panel click on the gear icon, and start typing a username and select them from the list. + Users who aren't a member of the PyCalendar organization won't appear. + Good peer review ```````````````` @@ -274,6 +282,7 @@ When submitting your pull request, complete the description template on GitHub, #. Add a test which proves your fix and passes. #. Run all tests to ensure your changes don't break any existing functionality. #. :doc:`Add or edit documentation `, both as docstrings to be rendered in the :doc:`API reference documentation <../reference/api/icalendar>` and narrative documentation, as necessary. +#. Request a :ref:`peer review `. The maintainers may close pull requests without providing feedback that they deem to be spam, AI slop, abuse, or that do not comply with pull request requirements. The maintainers may also take further action, including suspend, ban, or report GitHub users, as described in Python Calendaring Ecosystem's `Code of Conduct `_.