PEP 595 – Improving bugs.python.org | peps.python.org
PEP 595 – Improving bugs.python.org PEP 595 – Improving bugs.python.org Author : Ezio Melotti <ezio.melotti at gmail.com>, Berker Peksag <berker.peksag at gmail.com> BDFL-Delegate : Barry Warsaw <barry at python.org> Status : Withdrawn Type : Informational Created : 12-May-2019 Table of Contents Abstract Resolution Motivation Roundup advantages over GitHub Issues Improving Roundup PEP 581 issues Migration considerations Copyright Abstract This PEP proposes a list of improvements to make bugs.python.org more usable for contributors and core developers.
This PEP also discusses why remaining on Roundup should be preferred over switching to GitHub Issues, as proposed by PEP 581 . Resolution 2020-06-25: With the acceptance of PEP 581 , the move to GitHub for issues is proceeding, this PEP is being marked as a withdrawn informational PEP. Motivation On May 14th, 2019 PEP 581 has been accepted without much public discussion and without a clear consensus . The PEP contains factual errors and doesn’t address some of the issues that the migration to GitHub Issues might present.
Given the scope of the migration, the amount of work required, and how it will negatively affect the workflow during the transition phase, this decision should be re-evaluated. Roundup advantages over GitHub Issues This section discusses reasons why Roundup should be preferred over GitHub Issues and Roundup features that are not available on GitHub Issues. Roundup is the status quo. Roundup has been an integral part of the CPython workflow for years.
It is a stable product that has been tested and customized to adapt to our needs as the workflow evolved. It is possible to gradually improve it and avoid the disruption that a switch to a different system would inevitably bring to the workflow. Open-source and Python powered. Roundup is an open-source project and is written in Python. By using it and supporting it, we also support the Python ecosystem. Several features developed for bpo have also been ported to upstream Roundup over the years.
Fully customizable. Roundup can be (and has been) fully customized to fit our needs. Finer-grained access control. Roundup allows the creation of different roles with different permissions (e.g. create, view, edit, etc.) for each individual property, and users can have multiple roles. Flexible UI. While Roundup UI might look dated, it is convenient and flexible. For example, on the issue page, each field (e.g. title, type, versions, status, linked files and PRs, etc.) have appropriate UI elements (input boxes, dropdowns, tables, etc.) that are easy to set and also provide a convenient way to get info about the issue at a glance.
The number of fields, their values, and the UI element they use is also fully customizable. GitHub only provides labels. The issue list page presents the issues in a compact and easy to read table with separate columns for different fields. For comparison, Roundup lists 50 issues in a screen, whereas GitHub takes two screens to shows 25 issues. Advanced search. Roundup provides an accurate way to search and filter by using any combination of issue fields.
It is also possible to customize the number of results and the fields displayed in the table, and the sorting and grouping (up to two levels). bpo also provides predefined summaries (e.g. “Created by you”, “Assigned to you”, etc.) and allows the creation of custom search queries that can be conveniently accessed from the sidebar. Nosy list autocomplete. The nosy list has an autocomplete feature that suggests maintainers and experts.
The suggestions are automatically updated when the experts index changes. Dependencies and Superseders. Roundup allows to specify dependencies that must be addressed before the current issues can be closed and a superseder issue to easily mark duplicates (for example, bpo-12078 ). The list of dependencies can also be used to create meta-issues that references several other sub-issues (for example, bpo-26865 ). Improving Roundup This section lists some of the issues mentioned by PEP 581 and other desired features and discusses how they can be implemented by improving Roundup and/or our instance.
REST API support. A REST API will make integration with other services and the development of new tools and applications easier. Upstream Roundup now supports a REST API. Updating the tracker will make the REST API available. GitHub login support. This will allow users to login to bugs.python.org (bpo) without having to create a new account. It will also solve issues with confirmation emails being marked as spam, and provide two-factor authentication.
A patch to add this functionality is already available and is being integrated at the time of writing. Markdown support and message preview and editing. This feature will allow the use of Markdown in messages and the ability to preview the message before the submission and edit it afterward. This can be done, but it will take some work. Possible solutions have been proposed on the roundup-devel mailing list . “Remove me from nosy list” button.
Add a button on issue pages to remove self from the nosy list. This feature will be added during GSoC 2019. Mobile friendly theme. Current theme of bugs.python.org looks dated and it doesn’t work well with mobile browsers. A mobile-friendly theme that is more modern but still familiar will be added. Move reply box close to the last message. The reply box is located at the top of the page, whereas the last message is at the bottom.
The reply box can be moved or duplicated after the last message. Real-time updates. When another users submits changes to an issue, they should show up in real time. This can be accomplished by using the REST API. Add PR link to BPO emails. Currently bpo emails don’t include links to the corresponding PRs. A patch is available to change the content of the bpo emails from: components: +Tkinter versions: +Python 3.4 pull_requests: +42 to: components: +Tkinter versions: +Python 3.4 pull_request: https://github.com/python/cpython/pull/341 Python 3 support.
Using Python 3 will make maintenance easier. Upstream Roundup now supports Python 3. Updating the tracker will allow us to switch to Python 3. The instances will need to be updated as well. Use upstream Roundup. We currently use a fork of Roundup with a few modifications, most notably the GitHub integration. If this is ported upstream, we can start using upstream Roundup without having to maintain our fork. PEP 581 issues This section addresses some errors and inaccuracies found in PEP 581 .
The “Why GitHub?” section of PEP 581 lists features currently available on GitHub Issues but not on Roundup. Some of this features are currently supported: “Ability to reply to issue and pull request conversations via email.” Being able to reply by email has been one of the core features of Roundup since the beginning. It is also possible to create new issues or close existing ones, set or modify fields, and add attachments.
“Email notifications containing metadata, integrated with Gmail, allowing systematic filtering of emails.” Emails sent by Roundup contains metadata that can be used for filtering. “Additional privacy, such as offering the user a choice to hide an email address, while still allowing communication with the user through @-mentions.” Email addresses are hidden by default to users that are not registered. Registered users can see other users’ addresses because we configured the tracker to show them.
It can easily be changed if desired. Users can still be added to the nosy list by using their username even if their address is hidden. “Ability to automatically close issues when a PR has been merged.” The GitHub integration of Roundup automatically closes issues when a commit that contains “fixes issue <id>” is merged. (Alternative spellings such as “closes” or “bug” are also supported.) See this message for a recent example of this featu
The rest of this page is on the live site.