calpoly-csai / calpoly-csai/api

Setup GitHub Actions for auto type checking

Open
#14 2 comments 0 reactions 0 assignees View on GitHub
documentation testing
Dominant language
Python
Stars
9
Forks
4
PR merge metrics
No merged PRs in 30d

Description

## Objective
Support the [Report Test Coverage...][6] milestone by making writing test cases easier for us

## Key Result
Setup GitHub Actions for automatic type-checking of our codebase `on push` and `on PR`

## Details

* [Good Code Talk at PyCon 2018][2] by [Carl Meyer][1] about how **Instagram** avoids Python bugs by using [pyre][3] for type checking

* The official Python type checker is [MyPy][4] but somehow Pyre is ["faster for large codebases"][5]

[1]: https://www.linkedin.com/in/carljm/
[2]: https://www.youtube.com/watch?v=pMgmKJyWKn8
[3]: https://github.com/facebook/pyre-check
[4]: https://github.com/python/mypy/
[5]: https://youtu.be/pMgmKJyWKn8?t=1848
[6]: https://github.com/calpoly-csai/api/milestone/3

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.