Skip to content

πŸ’© State-of-the-Art Shitcode Principles

project
6.2K

Curated list of state-of-the-art shitcode principles your project should follow to call it a proper shitcode

  • JavaScript
  • StyleGuide
  • Coding
  • BestPractices

About

A tongue-in-cheek style guide for writing the worst possible code. Each principle is stated with a straight face and illustrated with a "good" and a "bad" example, where "good" is exactly what you should never do.

The principles cover the classics: naming variables as if the code were already obfuscated, mixing naming and formatting styles, never writing comments, failing silently, relying on global variables, avoiding tests and linters, and starting a project without a README. Read in reverse, it's a checklist of habits that make code hard to read and maintain, and projects that follow it can even display a badge.