TAMULib / CAP

MIT License
3 stars 2 forks source link

Tech debt tasks #190

Closed ghost closed 2 years ago

ghost commented 2 years ago

These tasks should be confirmed/performed on each Weaver/Spring Service. This note should be a template for comments of each PR into staging.

gitignore

https://github.com/github/gitignore

  1. Default Java gitignore plus common docker files to ignore
  2. Standalone apps (CAP, SAGE, Vireo) with Java, JavaScript gitignore plus common docker and weaver ui files to ignore
  3. Standardize sections for .gitignore (community by project type, docker, application specific)

README

Create multiple md files next to primary README.

  1. README.md

    • badges
    • name
    • overview
    • deployment
    • API documentation
    • license
  2. DEPLOYMENT.md

    • running for development
    • docker for development
    • docker for deployment

PR templates

Template defined for service and client

Issue templates

Issues regarding intended purpose of service and client repositories.

  1. bug template
  2. feature template