You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 0c3d545
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/maintainer-guide.md
+16-33Lines changed: 16 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,6 @@
1
-
At present the active maintainers are (alphabetically):
2
-
3
-
* Rebecca Chen (@rchen152)
4
-
* Jukka Lehtosalo (@JukkaL)
5
-
* Ivan Levkivskyi (@ilevkivskyi)
6
-
* Sebastian Rittau (@srittau)
7
-
* Guido van Rossum (@gvanrossum)
8
-
* Brian Schubert (@brianschubert)
9
-
* Shantanu (@hauntsaninja)
10
-
* Nikita Sobolev (@sobolevn)
11
-
* Samuel Therrien (@Avasam)
12
-
* Aku Viljanen (@Akuli)
13
-
* Alex Waygood (@AlexWaygood)
14
-
* Jelle Zijlstra (@JelleZijlstra)
15
-
16
-
Former maintainers include:
17
-
18
-
* David Fisher (@ddfisher)
19
-
* Matthias Kramm (@matthiaskramm)
20
-
* Łukasz Langa (@ambv)
21
-
* Greg Price (@gnprice)
22
-
* Rune Tynan (@CraftSpider)
1
+
# Guidelines for typeshed Maintainers
2
+
3
+
## Maintainer Removal
23
4
24
5
For security reasons, maintainers who haven't been active for twelve months
25
6
(no PR reviews or merges, no opened PRs, no significant participation in
@@ -29,14 +10,14 @@ They will also be moved to the "former maintainers" section here.
29
10
Former maintainers who want their access rights restored should open
30
11
an issue or mail one of the active maintainers.
31
12
32
-
## Maintainer guidelines
13
+
## Preparing and Submitting Changes
33
14
34
15
The process for preparing and submitting changes as outlined
35
-
in the [CONTRIBUTING document](./CONTRIBUTING.md) also applies to
16
+
in the [CONTRIBUTING document](../CONTRIBUTING.md) also applies to
36
17
maintainers. This ensures high quality contributions and keeps
37
18
everybody on the same page. Do not make direct pushes to the repository.
38
19
39
-
###Reviewing and merging pull requests
20
+
## Reviewing and Merging Pull Requests
40
21
41
22
When reviewing pull requests, follow these guidelines:
42
23
@@ -59,9 +40,9 @@ When merging pull requests, follow these guidelines:
59
40
and assume that the reader has no access to the diff.
60
41
* Delete branches for merged PRs (by maintainers pushing to the main repo).
61
42
62
-
###Marking PRs as "deferred"
43
+
## Marking PRs as "deferred"
63
44
64
-
*See also the [guidelines in the CONTRIBUTING file](./CONTRIBUTING.md#marking-prs-as-deferred).*
45
+
*See also the [guidelines in the CONTRIBUTING file](../CONTRIBUTING.md#marking-prs-as-deferred).*
65
46
66
47
PRs should only be marked as "deferred" if there is a clear path towards getting
67
48
the blocking issue resolved within a reasonable time frame. If a PR depends on
@@ -71,25 +52,27 @@ the PEP stage, it should instead be closed.
71
52
Maintainers who add the "deferred" label should state clearly what exactly the
72
53
blocker is, usually with a link to an open issue in another project.
73
54
74
-
### Closing stale PRs
55
+
## Issue/PR Message Templates
56
+
57
+
### Closing Stale PRs
75
58
76
-
*See also the [guidelines in the CONTRIBUTING file](./CONTRIBUTING.md#closing-stale-prs).*
59
+
*See also the [guidelines in the CONTRIBUTING file](../CONTRIBUTING.md#closing-stale-prs).*
77
60
78
61
We want to maintain a welcoming atmosphere for contributors, so use a friendly
79
62
message when closing the PR. Example message:
80
63
81
64
Thanks for contributing! I'm closing this PR for now, because it still <fails some tests OR has unresolved review feedback OR has a merge conflict> after three months of inactivity. If you are still interested, please feel free to open a new PR (or ping us to reopen this one).
82
65
83
-
### Closing PRs for future standard library changes
66
+
### Closing PRs for Future Standard Library Changes
84
67
85
-
*See also the [guidelines in the CONTRIBUTING file](./CONTRIBUTING.md#standard-library-stubs).*
68
+
*See also the [guidelines in the CONTRIBUTING file](../CONTRIBUTING.md#standard-library-stubs).*
86
69
87
70
When rejecting a PR for a change for a future Python version, use a message
88
71
like:
89
72
90
73
Thanks for contributing! Unfortunately, [as outlined in our CONTRIBUTING document](https://github.com/python/typeshed/blob/main/CONTRIBUTING.md#standard-library-stubs) we only accept pull requests to the standard library for future Python versions after the first beta version has been released. This is in part to prevent churn in the stubs, and in part because the testing infrastructure for the future version is not yet in place. Please feel free to open a new PR when the first beta version has been released. Alternatively, if this PR is still relevant, you can leave a comment here to reopen it.
91
74
92
-
### Closing requests for third-party stubs
75
+
### Closing Requests for Third-Party Stubs
93
76
94
77
We don't keep requests for third-party library stubs open. Close those
95
78
requests as "not planned" with an explanation like this:
@@ -98,7 +81,7 @@ requests as "not planned" with an explanation like this:
98
81
99
82
That said, we don't keep requests for third-party library stubs open, unless there are issues that need to be addressed before a PR can be opened. Therefore, I'm closing this issue.
100
83
101
-
### Asking to remove tests
84
+
### Asking to Remove Tests
102
85
103
86
Please remove the tests. In typeshed, we only add regression tests for functions and classes which are known to have caused complex problems in the past, or where stubs are difficult to get right. 100% test coverage for typeshed is neither necessary nor desirable, as it would lead to code duplication.
0 commit comments