README.md

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 (Settings > Manage Access):
   • xmidt-org/admins with Admin role
   • xmidt-org/server-writers with Write role
4. Manually create the first release. After v0.0.1 exists, other releases will be made by automation after the CHANGELOG is updated to reflect a new version header and nothing under the Unreleased header.
5. For libraries:
   1. Add org workflows in dir .github/workflows: push, tag, and release. This can be done by going to the Actions tab for the repo on the github site.
   2. Remove the following files/dirs: .dockerignore, Dockerfile, Makefile, rpkg.macros, __PROJECT__.yaml, deploy/, and conf/.
6. For applications:
   1. Remove PkgGoDev badge from this file.
   2. Add org workflows in dir .github/workflows: push, tag, release, and docker-release. This can be done by going to the Actions tab for the repo on the github site.
   3. Add project name, .ignore, and errors.txt to .gitignore file.
   4. Update Dockerfile - choose new ports to expose that no current XMiDT application is using.
   5. Update deploy/packaging/__PROJECT__.spec file to have a proper Summary and Description.
   6. Update conf/__PROJECT__.service file to have a proper Description.

Summary

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

Table of Contents

• Code of Conduct
• Details
• Install
• Contributing

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.

Details

Add details here.

Install

Add details here.

Contributing

Refer to CONTRIBUTING.md.