Giter Club home page Giter Club logo

template-go's Introduction

Golang Template

Template for golang projects @okp4.

version lint build test codecov conventional commits semantic-release Contributor Covenant License

Purpose & Philosophy

This repository holds the template for building Golang projects with a consistent set of standards accros all OKP4 projects. We are convinced that the quality of the code depends on clear and consistent coding conventions, with an automated enforcement (CI).

This way, the template promotes:

  • the use of conventional commits, semantic versioning and semantic releasing which automates the whole package release workflow including: determining the next version number, generating the release notes, and publishing the artifacts (project tarball, docker images, etc.)
  • unit testing
  • linting via golangci-lint
  • a uniformed way of building the project for several platforms via a Makefile using a docker image

How to use

๐Ÿšจ do not fork this repository as it is a template repository

  1. Click on Use this template
  2. Give a name to your project
  3. Wait until the first run of CI finishes
  4. Clone your new project and happy coding!

Prerequisites

  • Be sure you have Golang installed.
  • Docker as well if you want to use the Makefile.

Build

make build

template-go's People

Contributors

trulacgc-tcnetwork avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.