Skip to content

Commit

Permalink
fix: Typos in doc and make files (#287)
Browse files Browse the repository at this point in the history
Signed-off-by: Paul Mars <[email protected]>
Co-authored-by: Alex Lowe <[email protected]>
  • Loading branch information
upils and lengau authored Dec 9, 2024
1 parent 533a546 commit 2a0a524
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]:canonical/starbase.git``
- ``git merge --allow-unrelated-histories starbase/main``
- ``git remote remove starbase``
Expand All @@ -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 <your-repo>``
- ``git remote add starbase [email protected]: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)
Expand Down

0 comments on commit 2a0a524

Please sign in to comment.