Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 1.47 KB

README.md

File metadata and controls

36 lines (28 loc) · 1.47 KB

golang-project-template

What is this?

This is an template for golang project, it has the following features:

  • An Makefile style for build、test,support docker
  • Support custom license headers
  • Buildin grpc、grpc-gateway with example, proto-format、lint、doc enabled
  • Github template and action for PR、ISSUE and workflow
  • Go 1.21,with golangci-lint、mockgen and so on, and unittest is enabled
  • Codecov enabled

How to use?

  1. create an repository with this template, and clone it
  2. run ./hack/rename {xxx} to new project name
  3. follow codecov to configration your CODECOV_TOKEN
  4. modify .github/license.yml with your own LICENSE template
  5. modify .github/CODEOWNERS with your own OWNERS

Now, enjoy coding!