Skip to content

Commit 612ebc8

Browse files
authored
DOC Add triage team section in "About us" page (scikit-learn#17305)
1 parent 9368545 commit 612ebc8

File tree

4 files changed

+45
-22
lines changed

4 files changed

+45
-22
lines changed

build_tools/generate_authors_table.py

+25-21
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515

1616
print("user:", file=sys.stderr)
1717
user = input()
18-
passwd = getpass.getpass("Password or access token:\n")
19-
auth = (user, passwd)
18+
token = getpass.getpass("access token:\n")
19+
auth = (user, token)
2020

2121
LOGO_URL = 'https://avatars2.githubusercontent.com/u/365630?v=4'
2222
REPO_FOLDER = Path(path.abspath(__file__)).parent.parent
@@ -38,13 +38,15 @@ def get(url):
3838

3939
def get_contributors():
4040
"""Get the list of contributor profiles. Require admin rights."""
41-
# get members of scikit-learn core-dev on GitHub
41+
# get core devs and triage team
4242
core_devs = []
43-
team = 11523
44-
for page in [1, 2]: # 30 per page
45-
reply = get("https://api.github.com/teams/%d/members?page=%d" %
46-
(team, page))
47-
core_devs.extend(reply.json())
43+
triage_team = []
44+
for team_id, lst in zip((11523, 3593183), (core_devs, triage_team)):
45+
for page in [1, 2]: # 30 per page
46+
reply = get(
47+
f"https://api.github.com/teams/{team_id}/members?page={page}"
48+
)
49+
lst.extend(reply.json())
4850

4951
# get members of scikit-learn on GitHub
5052
members = []
@@ -55,32 +57,31 @@ def get_contributors():
5557
members.extend(reply.json())
5658

5759
# keep only the logins
58-
core_devs = [c['login'] for c in core_devs]
59-
members = [c['login'] for c in members]
60+
core_devs = set(c['login'] for c in core_devs)
61+
triage_team = set(c['login'] for c in triage_team)
62+
members = set(c['login'] for c in members)
6063

6164
# add missing contributors with GitHub accounts
62-
members.extend(['dubourg', 'mbrucher', 'thouis', 'jarrodmillman'])
65+
members |= {'dubourg', 'mbrucher', 'thouis', 'jarrodmillman'}
6366
# add missing contributors without GitHub accounts
64-
members.extend(['Angel Soler Gollonet'])
67+
members |= {'Angel Soler Gollonet'}
6568
# remove CI bots
66-
members.remove('sklearn-ci')
67-
members.remove('sklearn-lgtm')
68-
members.remove('sklearn-wheels')
69+
members -= {'sklearn-ci', 'sklearn-lgtm', 'sklearn-wheels'}
70+
triage_team -= core_devs # remove ogrisel from triage_team
6971

70-
# remove duplicate, and get the difference of the two sets
71-
core_devs = set(core_devs)
72-
members = set(members)
73-
emeritus = members.difference(core_devs)
72+
emeritus = members - core_devs - triage_team
7473

7574
# get profiles from GitHub
7675
core_devs = [get_profile(login) for login in core_devs]
7776
emeritus = [get_profile(login) for login in emeritus]
77+
triage_team = [get_profile(login) for login in triage_team]
7878

7979
# sort by last name
8080
core_devs = sorted(core_devs, key=key)
8181
emeritus = sorted(emeritus, key=key)
82+
triage_team = sorted(triage_team, key=key)
8283

83-
return core_devs, emeritus
84+
return core_devs, emeritus, triage_team
8485

8586

8687
def get_profile(login):
@@ -143,10 +144,13 @@ def generate_list(contributors):
143144

144145
if __name__ == "__main__":
145146

146-
core_devs, emeritus = get_contributors()
147+
core_devs, emeritus, triage_team = get_contributors()
147148

148149
with open(REPO_FOLDER / "doc" / "authors.rst", "w+") as rst_file:
149150
rst_file.write(generate_table(core_devs))
150151

151152
with open(REPO_FOLDER / "doc" / "authors_emeritus.rst", "w+") as rst_file:
152153
rst_file.write(generate_list(emeritus))
154+
155+
with open(REPO_FOLDER / "doc" / "triage_team.rst", "w+") as rst_file:
156+
rst_file.write(generate_table(triage_team))

doc/about.rst

+7
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,13 @@ in the FAQ.
3838

3939
:ref:`How you can contribute to the project <contributing>`
4040

41+
Triage Team
42+
-----------
43+
The following people are active contributors who also help with triaging
44+
issues, PRs, and general maintenance:
45+
46+
.. include:: triage_team.rst
47+
4148
Emeritus Core Developers
4249
------------------------
4350
The following people have been active contributors in the past, but are no

doc/authors.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
</div>
2020
<div>
2121
<a href='https://github.com/thomasjpfan'><img src='https://avatars2.githubusercontent.com/u/5402633?v=4' class='avatar' /></a> <br />
22-
<p>Thomas J Fan</p>
22+
<p>Thomas J. Fan</p>
2323
</div>
2424
<div>
2525
<a href='https://github.com/agramfort'><img src='https://avatars2.githubusercontent.com/u/161052?v=4' class='avatar' /></a> <br />

doc/triage_team.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. raw :: html
2+
3+
<!-- Generated by generate_authors_table.py -->
4+
<div class="sk-authors-container">
5+
<style>
6+
img.avatar {border-radius: 10px;}
7+
</style>
8+
<div>
9+
<a href='https://github.com/cmarmo'><img src='https://avatars3.githubusercontent.com/u/1662261?v=4' class='avatar' /></a> <br />
10+
<p>Chiara Marmo</p>
11+
</div>
12+
</div>

0 commit comments

Comments
 (0)