@@ -22,7 +22,7 @@ Rationale
22
22
23
23
CPython's development moved to GitHub on February 2017. All other projects
24
24
within the PSF's organization are hosted on GitHub and are using GitHub issues.
25
- CPython is still using Roundup as the issue tracker on bugs.python.org (bpo) [1 ]_.
25
+ CPython is still using Roundup as the issue tracker on bugs.python.org (bpo) [# ]_.
26
26
27
27
Why GitHub
28
28
----------
@@ -34,7 +34,7 @@ not currently available on Roundup / bpo.
34
34
existing integrations and applications available from GitHub Marketplace to
35
35
help with the workflow. New applications are easily installed and enabled.
36
36
In addition, we've had great success with building our own GitHub bots, like
37
- miss-islington [14 ]_, bedevere [15 ]_, and the-knights-who-say-ni [16 ]_.
37
+ miss-islington [# ]_, bedevere [# ]_, and the-knights-who-say-ni [# ]_.
38
38
39
39
- Ability to embed/drag and drop screenshots and debug log files into GitHub
40
40
pull requests and issues.
@@ -52,19 +52,19 @@ not currently available on Roundup / bpo.
52
52
53
53
- Support for voting via reactions.
54
54
55
- - Support for permalinks [2 ]_, allowing easy quoting and copying & pasting of
55
+ - Support for permalinks [# ]_, allowing easy quoting and copying & pasting of
56
56
source code.
57
57
58
58
- Core developers don't have to maintain the issue infrastructure/site, giving
59
59
us more time to focus on the development of Python.
60
60
61
- - Ability to automatically close issues when a PR has been merged [3 ]_.
61
+ - Ability to automatically close issues when a PR has been merged [# ]_.
62
62
63
63
- Lower barrier to contribution. With more than 28 million users, an open
64
64
source contributor is more likely to already have an account and be familiar
65
65
with GitHub's interface, making it easier to start contributing.
66
66
67
- - Email notifications containing metadata [4 ]_, integrated with Gmail, allowing
67
+ - Email notifications containing metadata [# ]_, integrated with Gmail, allowing
68
68
systematic filtering of emails.
69
69
70
70
- Additional privacy, such as offering the user a choice to hide an
@@ -82,7 +82,7 @@ Issues with Roundup / bpo
82
82
people who aren't already familiar with the code base.
83
83
84
84
- The upstream Roundup is in Mercurial. There is an open discussion about
85
- moving the source code of bpo to GitHub [5 ]_. If the source code of
85
+ moving the source code of bpo to GitHub [# ]_. If the source code of
86
86
bpo does move to GitHub, it will become difficult to update patches from
87
87
upstream. But as long as it is in Mercurial, it is difficult to maintain
88
88
and onboard new contributors.
@@ -93,13 +93,13 @@ Issues with Roundup / bpo
93
93
- Email address is exposed. There is no choice to mask it.
94
94
95
95
- There is no REST API available. There is an open issue in Roundup for adding
96
- REST API [6 ]_. Last activity was in 2016.
96
+ REST API [# ]_. Last activity was in 2016.
97
97
98
98
- It sends a number of unnecessary emails and notifications, and it is
99
99
difficult, if not impossible, to configure. An example is the nosy email,
100
100
where email notifications are sent whenever someone adds themselves as "nosy".
101
101
An issue has been filed in upstream Roundup about this since 2012 with
102
- little traction [7 ]_.
102
+ little traction [# ]_.
103
103
104
104
- Creating an account has been a hassle. There have been reports of people
105
105
having trouble creating accounts or logging in.
@@ -145,7 +145,7 @@ Backup of GitHub data
145
145
---------------------
146
146
147
147
This effort has been started and is being tracked as an issue in core-workflow
148
- [8 ]_. We're using GitHub's Migrations API [9 ]_ to download GitHub data for
148
+ [# ]_. We're using GitHub's Migrations API [# ]_ to download GitHub data for
149
149
CPython on a daily basis. The archives will be dropped in a S3 bucket.
150
150
151
151
Thanks to Ernest W. Durbin III for working on this.
@@ -258,19 +258,19 @@ A GitHub account should not be a requirement
258
258
--------------------------------------------
259
259
260
260
Back when moving the CPython codebase from Mercurial to GitHub was being
261
- discussed [10 ]_ [11 ]_, it was brought up that we still needed to allow uploading
261
+ discussed [# ]_ [# ]_, it was brought up that we still needed to allow uploading
262
262
of patches on bpo, and that a GitHub account should not be a requirement in
263
263
order to contribute to Python.
264
264
265
265
If bpo is made read-only, we'll need to come up with a different solution to
266
266
allow people to contribute when they don't have a GitHub account.
267
267
268
268
One solution is to create a new "python-issues" mailing list, similar to the
269
- [email protected] [
12 ]_ mailing list, to allow people to submit their issues
269
+ [email protected] [
# ]_ mailing list, to allow people to submit their issues
270
270
there.
271
271
272
272
Related to this, since the migration to GitHub in 2017, I recall one case
273
- [13 ]_ where there was a contributor, who submitted a patch to Mercurial and
273
+ [# ]_ where there was a contributor, who submitted a patch to Mercurial and
274
274
refused to create a GitHub account. Because of this, our bot was unable to
275
275
detect whether they had signed the CLA. Another person had volunteered to upload
276
276
their patch to GitHub. But it was still required that both people sign the CLA.
@@ -308,56 +308,56 @@ and ideas have been valuable.
308
308
References
309
309
==========
310
310
311
- .. [1 ] bugs.python.org
311
+ .. [# ] bugs.python.org
312
312
(https://bugs.python.org/)
313
313
314
- .. [2 ] Getting permanent links to files
314
+ .. [# ] miss-islington
315
+ (https://github.com/python/miss-islington)
316
+
317
+ .. [# ] bedevere
318
+ (https://github.com/python/bedevere)
319
+
320
+ .. [# ] the-knights-who-say-ni
321
+ (https://github.com/python/the-knights-who-say-ni)
322
+
323
+ .. [# ] Getting permanent links to files
315
324
(https://help.github.com/articles/getting-permanent-links-to-files/)
316
325
317
- .. [3 ] Closing issues using keywords
326
+ .. [# ] Closing issues using keywords
318
327
(https://help.github.com/articles/closing-issues-using-keywords/)
319
328
320
- .. [4 ] About GitHub email notifications
329
+ .. [# ] About GitHub email notifications
321
330
(https://help.github.com/articles/about-email-notifications/)
322
331
323
- .. [5 ] Consider whether or not to migrate bugs.python.org source code
332
+ .. [# ] Consider whether or not to migrate bugs.python.org source code
324
333
to GitHub repo
325
334
(https://github.com/python/bugs.python.org/issues/2)
326
335
327
- .. [6 ] Roundup issue 2550734: Expose roundup via a RESTful interface
336
+ .. [# ] Roundup issue 2550734: Expose roundup via a RESTful interface
328
337
(http://issues.roundup-tracker.org/issue2550734)
329
338
330
- .. [7 ] Roundup issue 2550742: Do not send email by default when adding
339
+ .. [# ] Roundup issue 2550742: Do not send email by default when adding
331
340
or removing oneself from the Nosy list
332
341
(http://issues.roundup-tracker.org/issue2550742)
333
342
334
- .. [8 ] Backup GitHub information
343
+ .. [# ] Backup GitHub information
335
344
(https://github.com/python/core-workflow/issues/20)
336
345
337
- .. [9 ] GitHub's Migrations API
346
+ .. [# ] GitHub's Migrations API
338
347
(https://developer.github.com/v3/migrations/orgs/)
339
348
340
- .. [10 ] Python-committers email
349
+ .. [# ] Python-committers email
341
350
(https://mail.python.org/pipermail/python-committers/2015-December/003642.html)
342
351
343
- .. [11 ] Python-committers email
352
+ .. [# ] Python-committers email
344
353
(https://mail.python.org/pipermail/python-committers/2015-December/003645.html)
345
354
346
- .. [12 ] docs mailing list
355
+ .. [# ] docs mailing list
347
356
(https://mail.python.org/mailman/listinfo/docs)
348
357
349
- .. [13 ] CPython GitHub pull request 1505
358
+ .. [# ] CPython GitHub pull request 1505
350
359
(https://github.com/python/cpython/pull/1505)
351
360
352
- .. [14 ] miss-islington
353
- (https://github.com/python/miss-islington)
354
-
355
- .. [15 ] bedevere
356
- (https://github.com/python/bedevere)
357
-
358
- .. [16 ] the-knights-who-say-ni
359
- (https://github.com/python/the-knights-who-say-ni)
360
-
361
361
362
362
Copyright
363
363
=========
0 commit comments