Coding Guidelines

• Shell Scripting Survival Guide
  • Introduction
    • Shell Choice
    • Pre-Requisite Knowledge
    • Conventions
      • Applicability
      • Filesystem Structure
      • Terminal Session Examples
      • Manual Pages Section References
  • Simple Techniques
    • Shebang
    • SELF
    • Error Message Printing
    • Error Induced Exits
    • Write Programs Not Functions
      • Clear Input/Output Definition
      • Functionally (Almost) Equivalent
      • Now You Have to Handle Installation
    • Avoid Directory Changes
    • xargs
    • Boolean Values
    • Null Globs
    • Sequence Expressions
    • Use Errexit Judiciously
    • Resource Cleanup
  • Architectural Techniques
    • Prelude
    • Command Dispatch
    • Argument Parsing
    • Debugging
    • Configuration
    • Installation
      • Source Structure
    • Testing
    • Documentation
    • Help output
  • Code Style
    • Breaking long lines
    • Path Definitions
  • Conclusion
  • Acknowledgements
  • Backlog
  • References
• Zsh Scripting Guide
  • Introduction
    • Conventions
  • Simple Techniques
    • Array Expansion
    • Array Indexing
    • Is a Value Present in Array?
    • Does a key exist?
  • Architectural Techniques
    • Argument Parsing
    • Debugging
  • Practical Case for Scripting
  • Philosophical Case for Scripting
  • Techniques Applied
  • Acknowledgements
  • References
• GNU Make Coding Guidelines
  • Getting Started
    • Source Structure
    • Using Make
    • Makefile Name
    • Install Recipe
  • Best Practices
    • Default Target
    • Install Targets
    • Directories
  • Example Uses
• Python Coding Guidelines
  • Black
  • Import Order
  • Wild Card Import Considered Harmful
  • Stop Writing Custom Logging Initializers
  • Backlog
• PHP Coding Guidelines
• General Coding Guidelines
  • Indentation
  • Don’t Repeat Yourself
    • Definition
    • Introduction
    • Application
  • Write Everything Twice
  • Parallelism vs. Concurrency
    • Parallelism
    • Concurrency
    • The Trick
    • See Also
    • References
  • Null Object Pattern
    • Practical Introduction
  • Engineering Trifecta
    • Correctness
    • Safety
    • Efficiency
  • Multiple Inheritance Considered Harmful
  • Shorten Names of High Impact Imports
  • Use Types and Type Hints to Encode Information
  • SOLID
  • Tell, Don’t Ask
  • General notes
  • Backlog