To provide easier build instructions with boilerplate ideas in the spirit of `build, develop, test, deploy
Why?
Keep code standardized and according to a proper format and code guidelines helps readers and developers make sense of how the code operates. Flake8 and black help to lint and format the code so a consistent style is visible across the project, and to protect against bugs (unused variables, unrecognized function calls, inconsistent code styling).
Also pipenv is much simpler to operate than virtualenv, with better dependency separation and python version specification.
Feedback required over
A quick pair of :eyes: on the code
Discussion on the technical approach
Critique on design
Feedback required when
Whenever feasible, no rush!
Mentions
@cbeddow your review, please
@OmarMuhammedAli what do you think? I think we should use tools such as flake8 and black to maintain standards across the project
Rubix982
commented
3 years ago
[Build+Structural Suggestions] Setup suggestions
Pull Request Type
🏆 Enhancements - build instructions, pipenv
📜 Documentation - README.md suggestions
🏠 Internal - Basic test structure
Purpose
To provide easier build instructions with boilerplate ideas in the spirit of `build, develop, test, deploy
Why?
Keep code standardized and according to a proper format and code guidelines helps readers and developers make sense of how the code operates.
Flake8andblackhelp to lint and format the code so a consistent style is visible across the project, and to protect against bugs (unused variables, unrecognized function calls, inconsistent code styling).Also
pipenvis much simpler to operate thanvirtualenv, with better dependency separation and python version specification.Feedback required over
Feedback required when
Whenever feasible, no rush!
Mentions
flake8andblackto maintain standards across the project