tveal / software-engineer-handbook Goto Github PK

New section for boolean logic

• truth tables
• breaking down a logic expression and simplifying
• why simplify?
  • reduced complexity
  • easier to read/code review/remember
  • easier testing/code coverage
  • less risk of bugs!

New test-driven-dev section on order of writing tests vs source code

• test purpose
  • fail in absence of source change
  • pass with source change
  • break the build if anyone unintentionally changes the functional behavior being added
• writer's (coder's) block
• do you know/understand the source change needed? the business use case?
• are the existing tests clear on how to test the new change?

Add disclaimers about many ways to do things; Pros and Cons to each; Understand your use case; Here's a time-proven way to optimize your work...

Document new Git section on how to make a code change ready to submit to trunk

• get latest from trunk
• branch off to task/bugfix/feature
• make small incremental commits and push
• rebase to trunk
• squash commits
• merge/pull request

Contrast to periodically pulling/merging trunk into your task/bugfix/feature branch

Document new Git section for how to squash commits

• mention to rebase feature branch to head of trunk first, reference appropriate section
• warning about squashing merge commits

git log
git rebase -i <trunk head commit>

Add:

• New chapter section for Pi Commander for overview of server/client design

Document new data section;

• the world runs on data
• once you publish data, consumers can become dependent
  • think twice on your data structure/schema before adding dependence on it
  • anticipate refactoring

Add:

• New chapter section for Pi Commander for scripting the wallpaper-with-qr-code
• Updates to the template-pi-commander repo
• Phase 1: QR code from IP
• Phase 2: Set wallpaper on Raspberry Pi
• Phase 3: Add ImageMagick

Explore various programming paradigms

• experience/takeaways from OOP
  • instance state-fullness
  • pure OO lang difficulties with utils (static methods)
  • nesting levels
  • magical things
• experience/takeaways from functional programming
  • explicit/verbose logic
  • stateless
• Pros/Cons; avoid favoring one exclusively; you need all in your toolbox

New Test-Driven-Dev section for patterns/reasons of using test fixture builders

• ease of adding/modifying tests as time goes on
• consistent test data across all tests
• builders make refactor and requirement changes easier

Add:

• New chapter section for Pi Commander for scripting the git updates
• Updates to the template-pi-commander repo
  • tag
  • link diff of tags

Create and seed a new template repo from Pi Commander: Getting Started

The art of code mocking with unit tests

• don't mock where you don't have to
• consider src code designs that simplify testing (compartmentalized logic units, simplifying logic branches and boolean logic)
• avoid mocking same class/file under test
• avoid mocking specific responses from DB calls when there's multiple DB interactions with the same unit (use fixture builder with more complete synthetic DB mock instead)

Document new Git section on how to rebase to head of the trunk branch

Add:

• New chapter section for Pi Commander for scripting the node provisioning
• Updates to the template-pi-commander repo
  • tag
  • link diff of tags

Add:

• New chapter section for Pi Commander for scripting the crontab
• Updates to the template-pi-commander repo
  • tag
  • link diff of tags