8000 Improve CONTRIBUTING.md (#824) · python/typeshed@05c6c66 · GitHub
[go: up one dir, main page]

Skip to content

Commit 05c6c66

Browse files
ambvddfisher
authored andcommitted
Improve CONTRIBUTING.md (#824)
1. Mentioned review requirement for core contributors. 2. Made stub coding style on par with requirements specified on the Mypy wiki (we can merge them now).
1 parent 4603baa commit 05c6c66

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ At present the core developers are (alphabetically):
7777
* Greg Price (@gnprice)
7878
* Guido van Rossum (@gvanrossum)
7979

80+
NOTE: the process for preparing and submitting changes also applies to
81+
core developers. This ensures high quality contributions and keeps
82+
everybody on the same page. Avoid direct pushes to the repository.
83+
8084

8185
## Preparing Changes
8286

@@ -127,6 +131,12 @@ rule is that they should be as concise as possible. Specifically:
127131
* prefer ``...`` on the same line as the class/function signature;
128132
* avoid vertical whitespace between consecutive module-level functions,
129133
names, or methods and fields within a single class;
134+
* use a single blank line between top-level class definitions, or none
135+
if the classes are very small;
136+
* add a top-level comment followed by an empty line that makes it clear
137+
the file contains a stub and not the actual code for the module,
138+
for example `# Stubs for pathlib (Python 3.4)`;
139+
* do not use docstrings;
130140
* prefer type comments over variable annotations unless your stubs are
131141
exclusively targeting Python 3.6.
132142

0 commit comments

Comments
 (0)
0