From 2769aa52a11ee856e8d7e7eb2845e3f13df10c5c Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Mon, 9 Jan 2023 15:40:44 +0200 Subject: [PATCH 1/3] Update info for GitHub issues --- documentation/help-documenting.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/help-documenting.rst b/documentation/help-documenting.rst index c8e320ccd..82e9865a2 100644 --- a/documentation/help-documenting.rst +++ b/documentation/help-documenting.rst @@ -52,8 +52,8 @@ typos to unclear documentation and items lacking documentation. If you see a documentation issue that you would like to tackle, you can: -* check to see if there is a paperclip or `octocat`_ icon at the end of the - issue's title column. If there is, then someone has already created a pull +* check to see if there is pull request icon to the right of the + issue's title. If there is, then someone has already created a pull request for the issue. * leave a comment on the issue saying you are going to try and create a pull request and roughly how long you think you will take to do so (this allows From 735f044afa1bde4007d1e64a41586944d998b246 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Mon, 9 Jan 2023 16:27:11 +0200 Subject: [PATCH 2/3] The mailing list no longer automatically receives bug reports from the issue tracker --- documentation/help-documenting.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/documentation/help-documenting.rst b/documentation/help-documenting.rst index 82e9865a2..23c1bb266 100644 --- a/documentation/help-documenting.rst +++ b/documentation/help-documenting.rst @@ -37,8 +37,7 @@ The in-development and recent maintenance branches are rebuilt once per day. If you would like to be more involved with documentation, consider subscribing to the `docs@python.org `_ -mailing list. The `issue tracker`_ sends new documentation issues to this -mailing list, and, less frequently, the list receives some directly mailed bug +mailing list which occasionally receives bug reports. The `docs-sig@python.org `_ mailing list discusses the documentation toolchain, projects, and standards. From 96df81b1e9f822398fb9ec64c5c779a3243cc662 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Mon, 9 Jan 2023 22:48:52 +0200 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: C.A.M. Gerlach --- documentation/help-documenting.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/documentation/help-documenting.rst b/documentation/help-documenting.rst index 23c1bb266..0da669b35 100644 --- a/documentation/help-documenting.rst +++ b/documentation/help-documenting.rst @@ -37,9 +37,10 @@ The in-development and recent maintenance branches are rebuilt once per day. If you would like to be more involved with documentation, consider subscribing to the `docs@python.org `_ -mailing list which occasionally receives bug -reports. The `docs-sig@python.org `_ -mailing list discusses the documentation toolchain, projects, and standards. +mailing list and the `Documentation category on the Python Discourse +`_, +where user issues are raised and documentation toolchain, projects, and standards +are discussed. Helping with documentation issues @@ -51,8 +52,9 @@ typos to unclear documentation and items lacking documentation. If you see a documentation issue that you would like to tackle, you can: -* check to see if there is pull request icon to the right of the - issue's title. If there is, then someone has already created a pull +* check to see if there is pull request icon to the right of the issue's title, + or an open pull request listed under :guilabel:`Linked PRs` in the issue body. + If there is, then someone has already created a pull request for the issue. * leave a comment on the issue saying you are going to try and create a pull request and roughly how long you think you will take to do so (this allows