Skip to content

Change link for documentation issues and introduce usage of icons on … #322

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 2, 2018
Merged

Change link for documentation issues and introduce usage of icons on … #322

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions docquality.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,22 @@ Helping with issues filed on the issue tracker
----------------------------------------------

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

If you decide to tackle a documentation issue, you can simply submit a
:doc:`pull request <pullrequest>` for the issue. If you are worried that someone
else might be working simultaneously on the issue, simply 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 it (this allows others to take on the issue if you
happen to forget or lose interest).
else might be working simultaneously on the issue, first check to see if there
is a paperclip or `octocat`_ icon at the end of the title column. If there
is, then someone has already attached a patch or created a pull request for the
issue. If there aren't any icons, then simply 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 it (this allows others to take on the issue if
you happen to forget or lose interest).

.. _issue tracker: https://bugs.python.org
.. _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
.. _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
.. _octocat: https://github.com/logos


Proofreading
Expand Down