Skip to content

Commit

Permalink
docs: fix spacing errors in README (#331)
Browse files Browse the repository at this point in the history
  • Loading branch information
bepri authored Jan 24, 2025
1 parent fbd7c43 commit de0d308
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Migrate existing projects
#. Update this guide as you go along, if something is unclear or missing.

#. Use ruff.

#. Pull in the bare minimum ``pyproject.toml`` needed to use ruff.
#. Make your codebase pass with ruff. Commit after each step:

Expand All @@ -40,8 +41,10 @@ Migrate existing projects
with:
- ``ruff check --fix``
- ``ruff format``

#. Modify top-level files in your project to match what's in Starbase as closely
as possible.

#. ``Makefile`` - Ensure you use ``uv`` and at least have the same targets:

- ``setup``
Expand All @@ -56,7 +59,9 @@ Migrate existing projects
#. ``README`` - If your readme is .md, convert to .rst with pandoc:
``pandoc -o README.rst README.md``
Don't worry about making the contents match, Starbase's is very specific.

#. Run all the linters: ``make lint``

#. ``mypy``:

- Mypy checks the same things as ``ruff``'s ``ANNXXX`` checks, but
Expand Down

0 comments on commit de0d308

Please sign in to comment.