Code Monkey home page Code Monkey logo

.go-template's Introduction

PROJECT

PROJECT does something good.

Build Status codecov.io Go Report Card Apache V2 License Quality Gate Status GitHub release PkgGoDev

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

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.

.go-template's People

Contributors

joe94 avatar kcajmagic avatar kristinapathak avatar schmidtw 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.