canonical / starbase

A base repository for packages from the Starcraft team
GNU Lesser General Public License v3.0
8 stars 4 forks source link

starbase


A base repository for Starcraft projects.

Description

This project is designed to act as the basis for any future starcraft projects as well as a testbed for any tooling changes we want to make before merging them into other projects.

Structure

TODO

How to migrate existing projects

TODO

How to create a new project

[TODO: Make this a template repository.]

. Use this template_ to create your repository.

. Ensure the LICENSE file represents the current best practices from the

Canonical legal team for the specific project you intend to release. (LGPL v3 for libraries, GPL v3 for applications.)

. Rename any files or directories and ensure references are updated.

. Replace any appropriate starcraft references with the appropriate name.

. Put correct contact information into CODE_OF_CONDUCT.md

. Write a new README

. Import your documentation to ReadTheDocs_.

.. _EditorConfig: https://editorconfig.org/ .. _pre-commit: https://pre-commit.com/ .. _ReadTheDocs: https://docs.readthedocs.io/en/stable/intro/import-guide.html .. _use this template: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template