From 2a0a5243f1500996e9432c1e64a3c6a7e897ed4e Mon Sep 17 00:00:00 2001 From: Upils <5464641+upils@users.noreply.github.com> Date: Mon, 9 Dec 2024 23:20:22 +0100 Subject: [PATCH] fix: Typos in doc and make files (#287) Signed-off-by: Paul Mars Co-authored-by: Alex Lowe --- README.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 41260df..2acce3c 100644 --- a/README.rst +++ b/README.rst @@ -85,7 +85,8 @@ Migrate existing projects #. If you're rebasing a library, add the integrations tests structure. Applications should use spread for integration tests. -# Finally, once all files are manually synced, actually sync the git history: +#. Finally, once all files are manually synced, actually sync the git history: + - ``git remote add starbase git@github.com:canonical/starbase.git`` - ``git merge --allow-unrelated-histories starbase/main`` - ``git remote remove starbase`` @@ -99,11 +100,18 @@ Create a new project -------------------- #. `Use this template`_ to create your repository. +#. Sync the git history with starbase to ease future merging: + - ``git clone `` + - ``git remote add starbase git@github.com:canonical/starbase.git`` + - ``git merge --allow-unrelated-histories starbase/main`` + - ``git push -f origin main`` + - ``git remote remove starbase`` #. 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. #. Rename any files or directories and ensure references are updated. -#. Replace any instances of the word ``Starcraft`` with the product's name. +#. Replace any instances of the words ``Starcraft`` and ``starbase`` with the product's + name. #. Place contact information in a code of conduct. #. Rewrite the README. #. If a Diataxis quadrant (tutorials, how-tos, references, explanations)