Commitizen for Standardized Commits

Oct 13, 2025 by thesweetdesigns.com 132 views

As a developer, setting up a solid foundation for further development is crucial. In this article, we will guide you through the process of initializing a Go repository with essential tooling, ensuring a clean, maintainable, and Go-idiomatic repository from the start.

Setting Up the Repository

Before implementing any functionality, the repository should be properly structured and equipped with best-practice tooling. This includes a working "Hello World" in Go, pre-commit hooks, Commitizen for conventional commits, and log/slog for logging in logfmt format.

Repository Setup & Basic Go Project

To start, we need to initialize a new Go module using the go mod init command. This will create a go.mod file in the root of our project, which will serve as the dependency manager for our Go project.

go mod init free@home

Next, we need to create a simple main.go file that prints "Hello, free@home!". This will serve as our "Hello World" example.

package main

import (
	"log/slog"
)

func main() {
	slog.Info("msg=application_started version=0.1.0")
}

We will also use log/slog to log a startup message in logfmt format. This will ensure that our logs are structured and easy to read.

Pre-commit Hooks for Code Quality

To ensure that our code is of high quality, we need to set up pre-commit hooks. These hooks will run on staged files before each commit, ensuring that our code meets certain standards.

We will use pre-commit to set up our pre-commit hooks. This will include essential hooks like golangci-lint and gofmt.

pre-commit install

We will also validate that pre-commit runs on staged files before each commit.

Commitizen for Standardized Commits

To ensure that our commits are consistent and follow best practices, we will use Commitizen. This will allow us to use cz commit instead of git commit.

commitizen init

We will also ensure that developers can use cz commit instead of git commit.

Logging with `log/slog`

To ensure that our logs are structured and easy to read, we will use Go's log/slog package. This will allow us to log messages in logfmt format.

package main

import (
	"log/slog"
)

func main() {
	slog.Info("msg=application_started version=0.1.0")
}

We will also configure the logger to output in logfmt format.

Documentation & Contribution Guide

To ensure that developers can easily contribute to our project, we will provide a README.md with basic instructions. We will also include a CONTRIBUTING.md file explaining the coding and commit guidelines.

# README.md

## Getting Started

To get started with this project, simply run the following command:

```bash
go run main.go

Contributing

To contribute to this project, please follow the guidelines outlined in the CONTRIBUTING.md file.


```markdown
# CONTRIBUTING.md

## Coding Guidelines

* Follow the Go coding style guide.
* Use consistent naming conventions.
* Use meaningful variable names.

## Commit Guidelines

* Use the `cz commit` command to commit changes.
* Follow the conventional commit message format.

Definition of Done (DoD)

The repository is initialized and contains a working Go project. Pre-commit hooks enforce code quality. Commitizen ensures consistent commit messages. log/slog is set up for structured logging in logfmt format. Documentation is provided for developers.

Out of Scope for This Story

No actual API implementation or business logic. No testing or CI/CD setup at this stage.

Notes

This setup ensures a clean, maintainable, and Go-idiomatic repository from the start. Future iterations will build on this foundation.

In our previous article, we walked through the process of initializing a Go repository with essential tooling. Now, we'll answer some frequently asked questions to help you better understand the process.

Q: What is the purpose of initializing a Go repository?

A: Initializing a Go repository sets up a solid foundation for further development. It ensures that your project is properly structured and equipped with best-practice tooling, making it easier to maintain and scale.

Q: What are the essential tooling requirements for a Go repository?

A: The essential tooling requirements for a Go repository include:

A working "Hello World" in Go
Pre-commit hooks for code quality
Commitizen for conventional commits
log/slog for logging in logfmt format
Documentation and contribution guidelines

Q: What is the difference between `log/slog` and the standard Go logging package?

A: log/slog is a structured logging package that outputs logs in logfmt format. This makes it easier to read and analyze logs. The standard Go logging package, on the other hand, outputs logs in a plain text format.

Q: Why is it important to use pre-commit hooks?

A: Pre-commit hooks ensure that your code meets certain standards before it is committed. This helps to prevent errors and inconsistencies in your codebase.

Q: What is Commitizen, and how does it help with commits?

A: Commitizen is a tool that helps you write consistent and meaningful commit messages. It follows the conventional commit message format, which makes it easier for developers to understand the changes made in each commit.

Q: What is the purpose of the `CONTRIBUTING.md` file?

A: The CONTRIBUTING.md file provides guidelines for developers who want to contribute to your project. It explains the coding and commit guidelines, making it easier for new contributors to get started.

Q: Can I skip any of the steps in initializing a Go repository?

A: While it's possible to skip some of the steps, it's not recommended. Each step is designed to ensure that your project is properly structured and equipped with best-practice tooling. Skipping steps can lead to errors and inconsistencies in your codebase.

Q: How do I know if my repository is properly initialized?

A: To ensure that your repository is properly initialized, follow the Definition of Done (DoD) outlined in our previous article. This includes:

A working Go project
Pre-commit hooks enforcing code quality
Commitizen ensuring consistent commit messages
log/slog set up for structured logging in logfmt format
Documentation provided for developers

By following these steps and answering these questions, you'll be well on your way to initializing a solid Go repository that's ready for further development. Happy coding!