Fix release workflow and update contrib docs (#43)

* Fix release workflow and update contrib docs

.github/workflows/publish-py.yaml

@@ -22,7 +22,6 @@ jobs:
       - name: Install dependencies
         run: |
           pip3 --quiet install --upgrade hatch uv twine
-          pip install -r requirements/build-pkg.txt
       - name: Build Package
         run: |
           hatch build --clean

CHANGELOG.md

@@ -98,7 +98,8 @@ Using the following categories, list your changes in this order:
 -   Rename `configure` to `create_router`.
 -   Rename from `idom-router` to `reactpy-router`.
 
-[Unreleased]: https://github.com/reactive-python/reactpy-router/compare/1.0.0...HEAD
+[Unreleased]: https://github.com/reactive-python/reactpy-router/compare/1.0.1...HEAD
+[1.0.1]: https://github.com/reactive-python/reactpy-router/compare/1.0.0...1.0.1
 [1.0.0]: https://github.com/reactive-python/reactpy-router/compare/0.1.1...1.0.0
 [0.1.1]: https://github.com/reactive-python/reactpy-router/compare/0.1.0...0.1.1
 [0.1.0]: https://github.com/reactive-python/reactpy-router/compare/0.0.1...0.1.0

docs/mkdocs.yml

@@ -14,9 +14,7 @@ nav:
       - Types: reference/types.md
   - About:
       - Changelog: about/changelog.md
-      - Contributor Guide:
-          - Code: about/code.md
-          - Docs: about/docs.md
+      - Contributor Guide: about/contributing.md
       - Community:
           - GitHub Discussions: https://github.com/reactive-python/reactpy-router/discussions
           - Discord: https://discord.gg/uNb5P4hA9X

docs/src/about/contributing.md

@@ -0,0 +1,70 @@
+## Creating a development environment
+
+If you plan to make code changes to this repository, you will need to install the following dependencies first:
+
+-   [Git](https://git-scm.com/downloads)
+-   [Python 3.9+](https://www.python.org/downloads/)
+-   [Hatch](https://hatch.pypa.io/latest/)
+
+Once you finish installing these dependencies, you can clone this repository:
+
+```shell
+git clone https://github.com/reactive-python/reactpy-router.git
+cd reactpy-router
+```
+
+## Executing test environment commands
+
+By utilizing `hatch`, the following commands are available to manage the development environment.
+
+### Tests
+
+| Command | Description |
+| --- | --- |
+| `hatch test` | Run Python tests using the current environment's Python version |
+| `hatch test --all` | Run tests using all compatible Python versions |
+| `hatch test --python 3.9` | Run tests using a specific Python version |
+| `hatch test -k test_navigate_with_link` | Run only a specific test |
+
+??? question "What other arguments are available to me?"
+
+    The `hatch test` command is a wrapper for `pytest`. Hatch "intercepts" a handful of arguments, which can be previewed by typing `hatch test --help`.
+
+    Any additional arguments in the `test` command are directly passed on to pytest. See the [pytest documentation](https://docs.pytest.org/en/stable/reference/reference.html#command-line-flags) for what additional arguments are available.
+
+### Linting and Formatting
+
+| Command | Description |
+| --- | --- |
+| `hatch fmt` | Run all linters and formatters |
+| `hatch fmt --check` | Run all linters and formatters, but do not save fixes to the disk |
+| `hatch fmt --linter` | Run only linters |
+| `hatch fmt --formatter` | Run only formatters |
+
+??? tip "Configure your IDE for linting"
+
+    This repository uses `hatch fmt` for linting and formatting, which is a [modestly customized](https://hatch.pypa.io/latest/config/internal/static-analysis/#default-settings) version of [`ruff`](https://github.com/astral-sh/ruff).
+
+    You can install `ruff` as a plugin to your preferred code editor to create a similar environment.
+
+### Documentation
+
+| Command | Description |
+| --- | --- |
+| `hatch run docs:serve` | Start the [`mkdocs`](https://www.mkdocs.org/) server to view documentation locally |
+| `hatch run docs:build` | Build the documentation |
+| `hatch run docs:linkcheck` | Check for broken links in the documentation |
+
+### Environment Management
+
+| Command | Description |
+| --- | --- |
+| `hatch build --clean` | Build the package from source |
+| `hatch env prune` | Delete all virtual environments created by `hatch` |
+| `hatch python install 3.12` | Install a specific Python version to your system |
+
+??? tip "Check out Hatch for all available commands!"
+
+    This documentation only covers commonly used commands.
+
+    You can type `hatch --help` to see all available commands.

docs/src/dictionary.txt

@@ -38,3 +38,7 @@ misconfigurations
 backhaul
 sublicense
 contravariant
+formatters
+linters
+linting
+pytest