Skip to content

habedi/template-go-project

Repository files navigation

A Template for Go Projects

template-go-project logo

Tests Linux Build Windows Build MacOS Build
Go Report Card Go Reference Code Coverage CodeFactor
Docs License Release Total Downloads

This is a template repository with a minimalistic structure to make it easier to start a new Go project. It is inspired by the recommendations in golang-standards/project-layout. I share it here in case it might be useful to others.

Features

  • Minimalistic project structure
  • Pre-configured GitHub Actions for testing, building, and releasing
  • Makefile for managing common tasks such as formatting, testing, and linting
  • Example configuration files for popular tools like golangci-lint
  • GitHub badges for tests, builds, code quality and coverage, documentation, etc.

Contributing

Please see CONTRIBUTING.md for details on how to make a contribution.

License

This project is licensed under the MIT License (LICENSE or https://opensource.org/licenses/MIT)