New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Review all code and APIs to convert from CrapCode #19

Open

alexkreidler opened this issue Dec 30, 2019 · 0 comments

Owner

alexkreidler commented Dec 30, 2019

check for "first-time readability"
centralize the docs so that they aren't scattered and necessary implementation details are in the code dirs while main user-facing/guide docs are in the docs/ dir
Have a friend or someone else try to read and review the code after this. Ask for questions, suggestions etc on APIs + design, readability, understandability of functions/breaking up even more, etc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment