chore: small fixes for makefile, license, ci and contributing (#53)

Author: Harshal6927

.pre-commit-config.yaml

@@ -1,8 +1,8 @@
 default_language_version:
-  python: "3.11"
+  python: "3.12"
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v5.0.0
     hooks:
       - id: check-ast
       - id: check-case-conflict
@@ -13,13 +13,13 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.0.292"
+    rev: "v0.8.1"
     hooks:
       - id: ruff
         args: ["--fix"]
       - id: ruff-format
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.3.0
     hooks:
       - id: codespell
         exclude: "page/_templates/code.html"

CONTRIBUTING.md CONTRIBUTING.md CONTRIBUTING.md renamed to CONTRIBUTING.md

@@ -6,31 +6,25 @@ the [Litestar Discord server](https://discord.gg/litestar). We're happy to help!
 
 ## Setting up the environment
 
-1. Install `PDM <https://pdm.fming.dev/latest/>`_
-2. Run ``pdm install`` to create a `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_ and install
-   the dependencies
-3. Install [Node.js](https://nodejs.org/en) - `https://nodejs.org/en`.
-4. Install [Pre-commit](https://pre-commit.com/) - Run `pre-commit install` to install pre-commit hooks.
-5. Run `make install` to install Python and Node dependencies.
-6. Activate the virtual environment. `Read more here <https://pdm.fming.dev/latest/usage/venv/#activate-a-virtualenv>`_.
+1. Install [UV](https://docs.astral.sh/uv/getting-started/installation/).
+2. Run `uv sync` to create a [virtual environment](https://docs.python.org/3/tutorial/venv.html) and install the dependencies.
+3. Activate the virtual environment. [Read more](https://docs.astral.sh/uv/pip/environments/#using-a-virtual-environment).
+4. Install [Node.js](https://nodejs.org/en).
+5. Run `pre-commit install` to install pre-commit hooks.
+6. Run `make install` to install Python and Node dependencies.
 7. Run `make serve` to start the development server.
 
 ## Tips
 
-Many modern IDEs like PyCharm or VS Code will enable the pdm-managed virtualenv that is created in step 2 for you
+Many modern IDEs like PyCharm or VS Code will enable the uv-managed virtualenv that is created in step 2 for you
 automatically.
+
 If your IDE / editor doesn't offer this functionality, then you will need to manually activate the virtualenv yourself.
 Otherwise, you may encounter errors or unexpected behaviour when trying to run the commands referenced within this
 document.
 
-The easiest way to activate this virtualenv manually as described at
-`Working with virtual environments <https://pdm.fming.dev/latest/usage/venv/#activate-a-virtualenv>` in
-PDM's documentation.
-
 The rest of this document will assume this environment is active wherever commands are referenced.
 
-## Code contributions
-
 ## Workflow
 
 1. Fork [this repository](https://github.com/litestar-org/litestar.dev/fork) on GitHub.
@@ -44,15 +38,15 @@ The rest of this document will assume this environment is active wherever comman
 7. Push the changes to your fork on GitHub.
 8. [Open a pull request](https://github.com/litestar-org/litestar.dev/compare)
 
-   In the title of the pull request, describe the changes you made and include the issue number if applicable. You may
-   use [Conventional Commits](https://www.conventionalcommits.org/) to structure your commit messages.
+    In the title of the pull request, describe the changes you made and include the issue number if applicable. You may
+    use [Conventional Commits](https://www.conventionalcommits.org/) to structure your commit messages.
 
-   For example:
+    For example:
 
-   - feat: allow provided a config object to extend other configs.
-   - fix: handle strings in config extending.
-   - docs: correct spelling of CHANGELOG.
-   - style: convert tabs to spaces.
+    - feat: allow provided a config object to extend other configs.
+    - fix: handle strings in config extending.
+    - docs: correct spelling of CHANGELOG.
+    - style: convert tabs to spaces.
 
 9. Wait for the CI to run and for a maintainer to review your changes. If any changes are requested, make them and
    commit them to the same branch. The CI will automatically run again, and the maintainer will review your changes
@@ -64,11 +58,11 @@ The rest of this document will assume this environment is active wherever comman
 
 ## Guidelines for writing documentation
 
-- All files should be written in [ReST](https://docutils.sourceforge.io/rst.html),
-  [Sphinx](https://www.sphinx-doc.org/en/master/), If you're unfamiliar with any of
-  those, [ReStructuredText primer](https://www.sphinx-doc.org/en/master/lib/usage/restructuredtext/basics.html),
-  and [Sphinx quickstart](https://www.sphinx-doc.org/en/master/lib/usage/quickstart.html) are recommended reads.
-- For CSS styling, we use [tailwindcss](https://tailwindcss.com/).
-- To run the documentation locally, run the command `make serve`.
-- To build the documentation, run the command `make page`.
-- To build the documentation and serve it locally, run the command `make serve`.
+-   All files should be written in [ReST](https://docutils.sourceforge.io/rst.html),
+    [Sphinx](https://www.sphinx-doc.org/en/master/), If you're unfamiliar with any of
+    those, [ReStructuredText primer](https://www.sphinx-doc.org/en/master/lib/usage/restructuredtext/basics.html),
+    and [Sphinx quickstart](https://www.sphinx-doc.org/en/master/lib/usage/quickstart.html) are recommended reads.
+-   For CSS styling, we use [tailwindcss](https://tailwindcss.com/).
+-   To run the documentation locally, run the command `make serve`.
+-   To build the documentation, run the command `make page`.
+-   To build the documentation and serve it locally, run the command `make serve`.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Starlite
+Copyright (c) 2021, 2022, 2023, 2024, 2025 Litestar Org.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -1,15 +1,20 @@
 .PHONY: page
 
 install:
-	pre-commit install
-	pdm install
+	uv sync
 	npm install
+	pre-commit install
 
 lint:
 	uv run pre-commit run --all-files
 
+ifeq ($(OS),Windows_NT)
+clean:
+	if exist page\_build rmdir /s /q page\_build
+else
 clean:
 	rm -rf page/_build
+endif
 
 build-assets:
 	npx tailwindcss -i page/index.css -o page/_static/index.css