rfc:github_issues
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
rfc:github_issues [2021/11/02 14:10] – nikic | rfc:github_issues [2021/12/04 14:22] (current) – nikic | ||
---|---|---|---|
Line 2: | Line 2: | ||
* Date: 2021-11-01 | * Date: 2021-11-01 | ||
* Author: Nikita Popov < | * Author: Nikita Popov < | ||
- | * Status: | + | * Status: |
===== Introduction ===== | ===== Introduction ===== | ||
Line 21: | Line 21: | ||
* **Accessibility**: | * **Accessibility**: | ||
* **Management of reported bugs**: For bug reporters without a php.net account, managing their reported bugs is very inconvenient. Editing a bug requires a per-bug password, and you can't easily track all the bugs you have reported. | * **Management of reported bugs**: For bug reporters without a php.net account, managing their reported bugs is very inconvenient. Editing a bug requires a per-bug password, and you can't easily track all the bugs you have reported. | ||
- | * **Mentions**: | + | * **Mentions**: |
* **Moving issues**: We are currently in an in-between state where implementation bugs are on bugs.php.net, | * **Moving issues**: We are currently in an in-between state where implementation bugs are on bugs.php.net, | ||
- | * **References**: | + | * **References**: |
* **Labels**: Bugs only support specifying a single package, there is no capability to apply multiple labels. For example, we have no way to mark beginner-friendly issues (the " | * **Labels**: Bugs only support specifying a single package, there is no capability to apply multiple labels. For example, we have no way to mark beginner-friendly issues (the " | ||
- | * **Check boxes**: bugs.php.net does not support check boxes, or edits to the bug description. This makes it impossible to use bugs.php.net for tracking issues, which consist of multiple sub-tasks. | + | * **Check boxes**: bugs.php.net does not support check boxes, or edits to the bug description. This makes it impossible to use bugs.php.net for tracking issues which consist of multiple sub-tasks. |
===== Proposal ===== | ===== Proposal ===== | ||
Line 43: | Line 43: | ||
{{: | {{: | ||
- | It requires an issue title, description and PHP version, and optionally accepts the used operating system. The description suggests (but does not require) | + | It requires an issue title, description and PHP version, and optionally accepts the used operating system. The description suggests (but does not require) |
The corresponding form for feature requests only accepts an issue title and description, | The corresponding form for feature requests only accepts an issue title and description, | ||
Line 165: | Line 165: | ||
==== Referencing issues ==== | ==== Referencing issues ==== | ||
- | Issues on GitHub can be referenced as ''# | + | Issues on GitHub can be referenced as ''# |
For this reason, it it proposed that GitHub issues should be referenced using '' | For this reason, it it proposed that GitHub issues should be referenced using '' | ||
Line 186: | Line 186: | ||
==== Other ==== | ==== Other ==== | ||
- | GitHub supports [[https:// | + | GitHub supports [[https:// |
GitHub also supports milestones, which we currently use to loosely track pull requests that should go into a certain PHP version. It would be possible to add all issues reported against a certain PHP version to the appropriate milestone, which would make the issues more reliably filterable by version. I do not propose to do this, because many issues are not version specific and their " | GitHub also supports milestones, which we currently use to loosely track pull requests that should go into a certain PHP version. It would be possible to add all issues reported against a certain PHP version to the appropriate milestone, which would make the issues more reliably filterable by version. I do not propose to do this, because many issues are not version specific and their " | ||
Line 207: | Line 207: | ||
* Reporting of security issues against PHP. | * Reporting of security issues against PHP. | ||
- | * Reporting of issues against PECL extensions. (We may want to discontinue this as well. Many actively maintained extensions already use GitHub issues rather than bugs.php.net.) | ||
* Commenting/ | * Commenting/ | ||
Line 213: | Line 212: | ||
* Reporting documentation problems. (Already disabled.) | * Reporting documentation problems. (Already disabled.) | ||
+ | * Reporting of issues against PECL extensions. (Extensions should have their own issue tracker. Most of them already track issues on GitHub, not bugs.php.net.) | ||
* Reporting non-security issues against PHP. | * Reporting non-security issues against PHP. | ||
+ | |||
+ | It may be possible to migrate security issues to GitHub as well, by making of use of the [[https:// | ||
===== Alternatives ===== | ===== Alternatives ===== | ||
Line 219: | Line 221: | ||
The switch to GitHub issues has two primary disadvantages: | The switch to GitHub issues has two primary disadvantages: | ||
- | * It binds the PHP project more firmly to the GitHub platform. We already host our repositories there and make use of pull request, but this would take additional functionality "out of our control" | + | * It binds the PHP project more firmly to the GitHub platform. We already host our repositories there and make use of pull requests, but this would take additional functionality "out of our control" |
* GitHub issues is not a particularly sophisticated issue tracker solution. While it offers many useful features that bugs.php.net does not, it is also less customizable. For example, there is no support for custom metadata on issues beyond standard features like labels or milestones (though there probably [[https:// | * GitHub issues is not a particularly sophisticated issue tracker solution. While it offers many useful features that bugs.php.net does not, it is also less customizable. For example, there is no support for custom metadata on issues beyond standard features like labels or milestones (though there probably [[https:// | ||
Line 230: | Line 232: | ||
Of course, the suggestion to use GitHub issues in particular is not an accident: | Of course, the suggestion to use GitHub issues in particular is not an accident: | ||
- | * We already host repositories there and use pull requests (and use it for documentation issues). Having everything on platform allows everything to integrate smoothly. Cross-references work everywhere out of the box. Other platforms will likely not be able to offer the same level of integration. | + | * We already host repositories there and use pull requests (and use it for documentation issues). Having everything on one platform allows everything to integrate smoothly. Cross-references work everywhere out of the box. Other platforms will likely not be able to offer the same level of integration. |
* GitHub has become the industry standard for open-source projects. Anyone with involvement in open-source is very likely to have an account there and be familiar with the main workflows. Using a different platform will likely require people to create a new account, learn the quirks of yet another issue tracker and have one more place to check for progress on reported issues. | * GitHub has become the industry standard for open-source projects. Anyone with involvement in open-source is very likely to have an account there and be familiar with the main workflows. Using a different platform will likely require people to create a new account, learn the quirks of yet another issue tracker and have one more place to check for progress on reported issues. | ||
The requirement for an alternative would be that a) it is hosted (i.e. the PHP project does not need to maintain infrastructure for it), b) has good GitHub integration and c) is " | The requirement for an alternative would be that a) it is hosted (i.e. the PHP project does not need to maintain infrastructure for it), b) has good GitHub integration and c) is " | ||
+ | |||
+ | ===== Vote ===== | ||
+ | |||
+ | Voting started 2021-11-20 and ends on 2021-12-04. | ||
+ | |||
+ | <doodle title=" | ||
+ | * Yes | ||
+ | * No | ||
+ | </ |
rfc/github_issues.txt · Last modified: 2021/12/04 14:22 by nikic