Skip to content
/ starbase Public template

A base repository for packages from the Starcraft team

License

Notifications You must be signed in to change notification settings

canonical/starbase

Repository files navigation

Release Documentation test

starbase

The base repository for Starcraft projects.

Description

This template code is the basis for all future starcraft projects, and acts as the testbed for any major tooling changes that we want to make before propagating them across all projects.

Structure

TODO

Migrate existing projects

TODO

Create a new project

[TODO: Make this a template repository.]

  1. Use this template to create your repository.
  2. Ensure the LICENSE file represents the current best practices from the Canonical legal team for the specific project you intend to release. We use LGPL v3 for libraries, and GPL v3 for apps.
  3. Rename any files or directories and ensure references are updated.
  4. Replace any instances of the word Starcraft with the product's name.
  5. Place contact information in a code of conduct.
  6. Rewrite the README.
  7. If a Diataxis quadrant (tutorials, how-tos, references, explanations) doesn't yet have content, remove its landing page from the TOC and delete its card in docs/index.rst. You can re-index it when at least one document has been produced for it.
  8. Register the product's documentation on our custom domain on Read the Docs for Business.