Code Quality - Githubissues

Data4Democracy / are-you-fake-news

16 stars 3 forks source link

Code Quality #12

Open N2ITN opened 6 years ago

N2ITN commented 6 years ago

Status

Assigning to @N2ITN @mlucas-NU

Issue

This code was made by one person and is now being open sourced. Code needs to be checked for sanity, consistency, interpretability in various ways.

Tasks

Step one

Check code for:

Sensical names: classes/variables/functions/methods/modules/files
Relevant, informative docstrings
Control flow of code is interpretable
Code coverage: unused abandoned code is removed

Step two:

Mega bonus points: add type annotations to the more complex code (example: web/webserver_get.py)