Skip to content

Commit 557d4db

Browse files
csabellancoghlan
authored andcommitted
Change link for documentation issues and introduce usage of icons on bug tracker (#322)
1 parent b0ed3bd commit 557d4db

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

docquality.rst

+10-6
Original file line numberDiff line numberDiff line change
@@ -34,18 +34,22 @@ Helping with issues filed on the issue tracker
3434
----------------------------------------------
3535

3636
If you look at `documentation issues`_ on the `issue tracker`_, you
37-
will find various documentation problems that need work. Issues vary from
37+
will find various documentation problems that may need work. Issues vary from
3838
typos, to unclear documentation, to something completely lacking documentation.
3939

4040
If you decide to tackle a documentation issue, you can simply submit a
4141
:doc:`pull request <pullrequest>` for the issue. If you are worried that someone
42-
else might be working simultaneously on the issue, simply leave a comment on the
43-
issue saying you are going to try and create a pull request and roughly how long
44-
you think you will take to do it (this allows others to take on the issue if you
45-
happen to forget or lose interest).
42+
else might be working simultaneously on the issue, first check to see if there
43+
is a paperclip or `octocat`_ icon at the end of the title column. If there
44+
is, then someone has already attached a patch or created a pull request for the
45+
issue. If there aren't any icons, then simply leave a comment on the issue
46+
saying you are going to try and create a pull request and roughly how long
47+
you think you will take to do it (this allows others to take on the issue if
48+
you happen to forget or lose interest).
4649

4750
.. _issue tracker: https://bugs.python.org
48-
.. _documentation issues: https://bugs.python.org/issue?%40search_text=&ignore=file%3Acontent&title=&%40columns=title&id=&%40columns=id&stage=&creation=&creator=&activity=&%40columns=activity&%40sort=activity&actor=&nosy=&type=&components=4&versions=&dependencies=&assignee=&keywords=&priority=&%40group=priority&status=1&%40columns=status&resolution=&nosy_count=&message_count=&%40pagesize=50&%40startwith=0&%40queryname=&%40old-queryname=&%40action=search
51+
.. _documentation issues: https://bugs.python.org/issue?%40search_text=&ignore=file%3Acontent&title=&%40columns=title&id=&%40columns=id&stage=&creation=&creator=&activity=&%40columns=activity&%40sort=activity&actor=&nosy=&type=&components=4&versions=&dependencies=&assignee=&keywords=6&priority=&status=1&%40columns=status&resolution=&nosy_count=&message_count=&%40group=&%40pagesize=100&%40startwith=0&%40sortdir=on&%40queryname=&%40old-queryname=&%40action=search
52+
.. _octocat: https://github.com/logos
4953

5054

5155
Proofreading

0 commit comments

Comments
 (0)