liveBook · Manning

Standard

As explained in Shipping Go: Develop, deliver, discuss, design, and go again

Standardization is the process of making work methods and outputs uniform through defined practices.

When another developer joins a project, a working application is not enough: they also need to know how to set it up, build it, and submit changes. Standardization makes those repeated steps predictable. Shared commands and documentation give contributors a practical set of instructions; automation can then run the same steps without relying on memory. section 2.2 section 2.6

Standardize the parts of the workflow that teammates repeat:

  • Put environment setup and build commands in a Makefile, then document how to run them in the README. A shared `make build` command lets developers and the pipeline use the same build procedure. section 2.2 section 2.3
  • Agree on code format, documentation, established patterns, and tests. The aim is not identical code—each change has its own purpose—but code teammates can read and check consistently. section 5.3
  • Give pull requests a common description and checklist. Review the process with the team and refine what is not working. section 5.1.5

Make formatting a pipeline gate

Add a `check-format` target that runs `test -z $$(go fmt ./...)`. Have a GitHub Actions format-check job run `make check-format`, and make the test job depend on it. This turns a shared style decision into an automatic check before later pipeline work proceeds. section 5.3

Listing 5.1 PULL_REQUEST_TEMPLATE.md
### Description
Please explain the changes you made here.
 
### Associated Task
Please list closed, fixed, or resolved issues here with a # and the number.
 
### Checklist
- [ ] Code compiles correctly
- [ ] Added tests that fail without the change (if possible)
- [ ] All tests passing
- [ ] Extended the documentation

The pull-request template turns expectations into a reusable prompt: describe the change, link the task, and check compilation, tests, and documentation before submission. section 5.1.5

Apply this rigor where people build a product together; an experimental personal project may not need it. As the team grows, keep checking whether the pipeline and its standards help delivery, and update documentation when the process changes. section 5.3 section 2.3 section 11.6

How Shipping Go: Develop, deliver, discuss, design, and go again covers it

How deep it goes
Works through Make commands and automated formatting checks, while leaving detailed lint configuration unspecified.
Examples
Illustrates shared practice with a Go setup Makefile and a pull-request checklist for compilation, tests, and documentation.
What it assumes
Assumes familiarity with repositories and development workflows while spelling out initial Go setup commands and pipeline steps.
What you can do after
Operate/configure shared Make targets and GitHub Actions checks so local work and the pipeline follow consistent procedures.
How it connects
Links standardization to documentation, code review, continuous integration, and automated quality checks.

Also explained in

Compare how 6 books explain standard →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Shipping Go: Develop, deliver, discuss, design, and go again. The section links point to the parts of the book it draws on.