PROJECT

PROJECT does something good.

Setup

1. Search and replace PROJECT with your project name.
2. Initialize go.mod file: go mod init github.com/xmidt-org/__PROJECT__
3. Add org teams to project (github.com Settings > Manage Access):
   • xmidt-org/admins with Admin role
   • xmidt-org/server-writers with Write role
4. Add options:
   • Settings > General
     • Select 'Allow auto-merge'
     • Select 'Automatically delete head branches'
5. Releases are created by tagging the repository like: v1.2.3 using SemVer and pushing the tag.
6. For libraries:
   1. Update the .github/workflow/ci.yml file so it says 'release-type': 'library'
7. For applications:
   1. Remove PkgGoDev badge from this file.
   2. Add project binaries to .gitignore file.
8. Fix the codecov.io badge by going here: https://app.codecov.io/gh/xmidt-org/__PROJECT__/config/badge and getting the badge link.

Summary

Summary should be a small paragraph explanation of what this project does.

Details

Add details here.

Install

Add details here.

Contributing

Refer to CONTRIBUTING.md.

Code of Conduct

This project and everyone participating in it are governed by the XMiDT Code Of Conduct. By participating, you agree to this Code.