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
Similar to what happened when we took over Jefferson, we want to establish a baseline in terms of code quality.
To do so, I opened a onekey-baseline branch where we can work towards that goal. Here's the TODO list:
Level 1 baseline
move from setuptools to Poetry
setup pre-commit hooks
implement code quality checks with Ruff
implement dead code check with vulture
Level 2 baseline
fix the code to pass ruff checks
fix the code according to vulture (whitelist should be as small as possible)
fix pyright issues (add type hints wherever possible, 81 errors right now)
Level 3 baseline
implement unit tests with pytest
implement integration tests with pytest
Level 4 baseline
implement CLI using click using command subcommand scheme
generic code refactoring
implement CI to execute pre-commit checks, pyright, and pytests on Python 3.8 -> Python 3.11
implement CD to push to PyPi on tagged releases
Refactoring will probably happen organically as we increase in level. Please keep commits as atomic as possible and communicate if you want to work in that branch.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Similar to what happened when we took over Jefferson, we want to establish a baseline in terms of code quality.
To do so, I opened a
onekey-baseline
branch where we can work towards that goal. Here's the TODO list:Level 1 baseline
Level 2 baseline
ruff
checksvulture
(whitelist should be as small as possible)Level 3 baseline
Level 4 baseline
click
usingcommand subcommand
schemeRefactoring will probably happen organically as we increase in level. Please keep commits as atomic as possible and communicate if you want to work in that branch.
Beta Was this translation helpful? Give feedback.
All reactions