VimPlug/typeshed
1
0
Fork 0
mirror of https://github.com/davidhalter/typeshed.git synced 2026-02-06 01:47:41 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

CONTRIBUTING.md (#790)

Browse Source 
Fixes #772.
This commit is contained in:
Łukasz Langa
2016-12-24 08:46:08 -08:00
committed by Guido van Rossum
parent 8e9c53f1db
commit 08432484d5
2 changed files with 192 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -2,11 +2,15 @@
## About
Typeshed models function types for the Python standard library
Typeshed contains external type annotations for the Python standard library
and Python builtins, as well as third party packages.
This data can e.g. be used for static analysis, type checking or type inference.
For information on how to use `typeshed`, read below. Information for
contributors can be found in [CONTRIBUTING.md](CONTRIBUTING.md). **Please read
it before submitting pull requests.**
## Format
Each Python module is represented by a `.pyi` "stub". This is a normal Python
@@ -89,6 +93,11 @@ This can be used for modules in 2and3/ that only have minor changes between
Python 2 and Python 3. If the difference between versions is more drastic, it
can make more sense to have seperate files in 2.x/ and 3.x/.
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) before submitting pull
requests.
## Running the tests
The tests are automatically run by Travis CI on every PR and push to