Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Typos in doc and make files #287

Merged
merged 5 commits into from
Dec 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading