project-checklist.md

Project Maintenance Checklist

• HTTPS Status Badges
  • TravisCI/CircleCI status badge
  • Quay Status badge for images
  • Godoc status badge for public Go packages
• Travis CI used to test public projects
  • test the app/binary
  • test the ACI
• Circle CI used to test private projects
  • test the app/binary
  • test the ACI
• Usage
  • Shows rkt fetch from Quay
  • Shows rkt run
  • Shows docker pull and run (for backwards compat.)
• Flags and environment variables table
• Development
  • Build the binary or app locally
  • Build the ACI locally
  • Build the Docker image locally
  • Run the ACI locally
  • Run the Docker image locally
• Documentation
  • Runbooks are updated.
  • README is updated
  • Godoc docs updated for Go projects
  • PyPI docs updated for Python projects
• Automation
  • TravisCI/CircleCI build ACIs
  • TravisCI/CircleCI build docker images
  • TravisCI/CircleCI push docker images to Quay and GCR
  • TravisCI/CircleCI push ACIs to Quay