a
a
aizatto.com
Build.myGitHubLinkedinNotion
Search…
aizatto.com
Table of Contents
Portfolio, Projects, Tools, Toys
Interview Guide
Engineering Code
Communication
Different Types of Coding
Commit Messages
Reviewing Code
Writing Code
Consistency
Writing for a code base of 1,000,000+ Lines
Write Code Knowing It Will Be Refactored
Naming
Commenting
Make It Easy To Reproduce
Scripts
80 character limit
Exit Early
Be careful of enum in switch statements
Be careful about chaining conditions
Be careful of chaining ternary operators
Write Code Knowing You Will be Blamed
Hacks
Bad Practices
Logs
Time
Other rules
Engineering Code
Engineering Data
Pipelines
Configuration Files
Site Reliability Engineering (SRE)
Best Engineers
Engineering Management
Why GitBook?
Getting into Tech
Personal Goals
Daily Drivers
Contacting Me
Notes
AWS
JavaScript
Node.js
Software Engineering
Technical Due Diligence
Web Development
Archive
More on Notion
Powered By GitBook
Scripts
When writing scripts, always leave a file header about what the script does, or link to a proper resource.
Add context on:
    How this script is used
    Why this script is needed
    How to run this script
Generally standalone scripts may leave out a lot of context.
Example of a decent script:
1
!/bin/sh
2
# Reencrypts the keys in our database.
3
# This is necessary because ....
4
# http://www.example.com/wiki/details
Copied!
​
Previous
Make It Easy To Reproduce
Next
80 character limit
Last modified 1yr ago
Copy link