Creating Order out of Chaos Learning, creating, sharing

The Style Guide: Package Layout 7 – Summary

It takes something more than intelligence to act intelligently.

– Fyodor Dostoyevsky

This post concludes the second unit of the book. Inside, you’ll find a complete list of suggestions about good package layout. Come on in.

The Style Guide: Package Layout 6 – Cross-Platform Packages Part III

When you develop your opinions on the basis of weak evidence, you will have difficulty interpreting subsequent information that contradicts these opinions, even if this new information is obviously more accurate.

– Nassim Nicholas Taleb

The third part of the cross-platform series focuses on the practical aspect of the question. It provides several examples of code organisation and tests in a cross-plaform package.

The Style Guide: Package Layout 5 – Cross-Platform Packages Part II

We know only too well that what we are doing is nothing more than a drop in the ocean.

But if the drop were not there, the ocean would be missing something.

– Mother Teresa

This is the second part in the series about designing cross-platform packages. It explores more advanced options for conditional compilation.

The Style Guide: Package Layout 4 – Cross-Platform Packages Part I

The most important thing is to read as much as you can, like I did.

It will give you an understanding of what makes good writing and it will enlarge your vocabulary.

– J. K. Rowling

This draft is the first in a series about designing packages in the cross-platform context. It covers some basic theory and tells about the simplest way to control the Go compiler depending on a platform.

The Style Guide: Package Layout 3 – Structure and Files

Live life as though nobody is watching, and express yourself as though everyone is listening.

– Nelson Mandela

One of the most important aspects of the package design is its structure. This post provides guidelines on organising files in a package in a sensible way.

The Style Guide: Package Layout 2 – Naming a Package

People cannot change their habits without first changing their way of thinking.

– Marie Kondō

This is the next piece of the Package Layout guidelines, and it tells you about choosing a good name for a package.

The Style Guide: Package Layout 1 – Intro

Simple can be harder than complex:

You have to work hard to get your thinking clean to make it simple. But it’s worth it in the end because once you get there, you can move mountains.

– Steve Jobs

With this post I continue publishing drafts of the book I’ve been working on since June 2020, Golocron – Software Development with Go. And this is the first post in a series of the new unit.

The Style Guide: Project Layout 6 – Summary

When you’re a carpenter making a beautiful chest of drawers, you’re not going to use a piece of plywood on the back, even though it faces the wall and nobody will ever see it. You’ll know it’s there, so you’re going to use a beautiful piece of wood on the back.

For you to sleep well at night, the aesthetic, the quality, has to be carried all the way through.

– Steve Jobs

This short post concludes the series of drafts for the first unit of the book. It’s the summary of what we have discussed recently. Here you can find an almost complete list of the recommendations introduced in previous articles.

The Style Guide: Project Layout 5 – Notes on Release Notes

What you don’t do can be a destructive force.

– Eleanor Roosevelt

A significant part of the release process is letting your users know about what’s changed in the software. This post highlights the importance of such commuication, and provides some ideas and guidelines on how to make it more efficient.

The Style Guide: Project Layout 4 – Versioning and Go

Order is never observed; it is disorder which attracts attention because it is awkward and intrusive.

– Eliphas Levi

This post covers another important topic in the context of the project layout, the process of creating and assigning new versions in a project. We first learn the theory, and then look at more practical aspects of it. Continue reading, if curious.