johnmcfarlane/essential.md

Created March 4, 2025 13:57

Star (0) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/johnmcfarlane/fb365c6b81a23195897d7cf461d336ce.js"></script>
Save johnmcfarlane/fb365c6b81a23195897d7cf461d336ce to your computer and use it in GitHub Desktop.

Download ZIP

Essential

Raw

essential.md

Essential Principles

Commonly occuring good advice.

Complexity

Avoid complexity.
Encourage simplicity.

Resources

Simple Made Easy - Rich Hickey (2011)

Coupling and Cohesion

Avoid coupling.
Encourage cohesion.

Examples

Functions
Classes
Source files / modules
Packages / projects
Teams

Graphs

Many phenomena are modelled by graphs. Some properties of graphs make them more difficult to work with. Trying to engineer the phenomena to affect these properties can have significant effects on complexity.

Cyclic Dependencies

Avoid cycles.

Examples

CI pipelines which are triggered by pushes, and also cause pushes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment