Skip to content

Tip for Testable Code & Spec Diagrams #12

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Tip for Testable Code & Spec Diagrams #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e984bfa
Added a tip for creating testable code
Mar 31, 2023
64c0c3b
Added tip for testable code with diagrams
Mar 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions tip-from-patimejia.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Code Quality Tips

Best Practices for Reliable Test-Driven Code: Linters, Microservices, and Docker to Avoid "Works on My Computer" Issues

1. Use linters and automated testing to ensure quality code (e.g. Flake8, Pylint, `pytest`).
1. Break code into microservices for easier testing and maintenance (e.g. REST APIs, AWS Lambda).
1. Test microservices with Pytest and `fixtures`, and use Docker for reliable testing/deployment (e.g. parametrized tests, mocks, containers, Kubernetes).
1. Create sequence diagrams (or **DAGs**) to visualize how different parts of the code interact with each other.