Update PEP 512 to denote that the initial GH work is done

This commit is contained in:
Brett Cannon 2016-04-01 10:52:34 -07:00
parent d6fe43240e
commit b31d3f0ea7
1 changed files with 29 additions and 19 deletions

View File

@ -172,12 +172,19 @@ tracking who has signed the PSF CLA will be continued by marking that
fact as part of someone's bugs.python.org user profile. What this fact as part of someone's bugs.python.org user profile. What this
means is that an association will be needed between a person's means is that an association will be needed between a person's
bugs.python.org [#b.p.o]_ account and their GitHub account, which bugs.python.org [#b.p.o]_ account and their GitHub account, which
will be done through a new field in a user's profile. will be done through a new field in a user's profile. This does
implicitly require that contributors will need both a
This does implicitly require that contributors will need both a
GitHub [#github]_ and bugs.python.org account in order to sign the GitHub [#github]_ and bugs.python.org account in order to sign the
CLA and contribute through GitHub. CLA and contribute through GitHub.
An API is provided to query bugs.python.org to see if a GitHub
username corresponds to someone who has signed the CLA. Making a GET
request to e.g.
http://bugs.python.org/user?@template=clacheck&github_names=brettcannon,notanuser
returns a JSON dictionary with the keys of the usernames requested
and a ``true`` value if they have sigend the CLA, ``false`` if they
have not, and ``null`` if no corresponding GitHub username was found.
A bot to enforce CLA signing A bot to enforce CLA signing
++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++
With an association between someone's GitHub account and their With an association between someone's GitHub account and their
@ -187,20 +194,22 @@ GitHub and denote whether the contributor has signed the CLA.
If the user has signed the CLA, the bot will add a positive label to If the user has signed the CLA, the bot will add a positive label to
the issue to denote the pull request has no CLA issues (e.g., a green the issue to denote the pull request has no CLA issues (e.g., a green
label stating, "CLA: ✓"). If the contributor has not signed a CLA, label stating, "CLA signed"). If the contributor has not signed a CLA,
a negative label will be added to the pull request will be blocked a negative label will be added to the pull request will be blocked
using GitHub's status API (e.g., a red label stating, "CLA: ✗"). If a using GitHub's status API (e.g., a red label stating, "CLA not signed").
contributor lacks a bugs.python.org account, that will lead to If a contributor lacks a bugs.python.org account, that will lead to
another label (e.g., "CLA: ✗ (no account)"). Using a label for both the negative label being used as well. Using a label for both
positive and negative cases provides a fallback notification if the positive and negative cases provides a fallback notification if the
bot happens to fail, preventing potential false-positives or bot happens to fail, preventing potential false-positives or
false-negatives. It also allows for an easy way to trigger the bot false-negatives. It also allows for an easy way to trigger the bot
again by simply removing a CLA-related label. again by simply removing a CLA-related label (this is in contrast to
using a GitHub status check [#gh-status-check]_ which is only
triggered on code changes).
If no pre-existing, maintained bot exists that fits our needs, one As no pre-existing bot exists to meet our needs, it will be hosted on
will be written from scratch. It will be hosted on Heroku [#heroku]_ Heroku [#heroku]_ and written to target Python 3.5 to act as a
and written to target Python 3.5 to act as a showcase for showcase for asynchronous programming. The code for the bot is hosted
asynchronous programming. in the Knights Who Say Ni project [#ni]_.
Requirements for Web-Related Repositories Requirements for Web-Related Repositories
----------------------------------------- -----------------------------------------
@ -526,21 +535,16 @@ benchmarks [#benchmarks-repo]_ repositories:
- `Create a 'python-dev' team`_ - `Create a 'python-dev' team`_
* In progress * In progress
- `A bot to enforce CLA signing`_: - `A bot to enforce CLA signing`_:
https://github.com/python/the-knights-who-say-ni (Brett Cannon) https://github.com/python/the-knights-who-say-ni (Brett Cannon)
- `Define commands to move a Mercurial repository to Git`_: - `Define commands to move a Mercurial repository to Git`_:
https://github.com/orsenthil/cpython-hg-to-git (Senthil Kumaran) https://github.com/orsenthil/cpython-hg-to-git (Senthil Kumaran)
- `Adding GitHub username support to bugs.python.org`_ (HTTP API):
http://psf.upfronthosting.co.za/roundup/meta/issue581
(Maciej Szulik and Ezio Melotti)
* Completed * Completed
- `Adding GitHub username support to bugs.python.org`_: - `Adding GitHub username support to bugs.python.org`_
GitHub usernames on bugs.python.org
(Maciej Szulik and Ezio Melotti) (Maciej Szulik and Ezio Melotti)
@ -882,6 +886,12 @@ References
.. [#heroku] Heroku (https://www.heroku.com/) .. [#heroku] Heroku (https://www.heroku.com/)
.. [#gh-status-check] GitHub status checks
(https://developer.github.com/v3/repos/statuses/)
.. [#ni] The Knights Who Say Ni project
(https://github.com/python/the-knights-who-say-ni)
Copyright Copyright
========= =========