add Development section to README and update contribution guide

Author: joshuadavidthomas

CONTRIBUTING.md

@@ -2,58 +2,106 @@
 
 All contributions are welcome! Besides code contributions, this includes things like documentation improvements, bug reports, and feature requests.
 
-You should first check if there is a [GitHub issue](https://github.com/joshuadavidthomas/django-bird/issues) already open or related to what you would like to contribute. If there is, please comment on that issue to let others know you are working on it. If there is not, please open a new issue to discuss your contribution.
+You should first check if there is a [GitHub issue](https://github.com/joshuadavidthomas/django-github-app/issues) already open or related to what you would like to contribute. If there is, please comment on that issue to let others know you are working on it. If there is not, please open a new issue to discuss your contribution.
 
 Not all contributions need to start with an issue, such as typo fixes in documentation or version bumps to Python or Django that require no internal code changes, but generally, it is a good idea to open an issue first.
 
 We adhere to Django's Code of Conduct in all interactions and expect all contributors to do the same. Please read the [Code of Conduct](https://www.djangoproject.com/conduct/) before contributing.
 
-## Setup
+### Requirements
+
+- [uv](https://github.com/astral-sh/uv) - Modern Python toolchain that handles:
+  - Python version management and installation
+  - Virtual environment creation and management
+  - Fast, reliable dependency resolution and installation
+  - Reproducible builds via lockfile
+- [direnv](https://github.com/direnv/direnv) (Optional) - Automatic environment variable loading
+- [just](https://github.com/casey/just) (Optional) - Command runner for development tasks
+
+### `Justfile`
+
+The repository includes a `Justfile` that provides all common development tasks with a consistent interface. Running `just` without arguments shows all available commands and their descriptions:
+
+```bash
+$ just
+# or explicitly
+$ just --list --list-submodules
+<!-- [[[cog
+import subprocess
+import cog
+
+output_raw = subprocess.run(['just', '--list', '--list-submodules'], stdout=subprocess.PIPE)
+output_list = output_raw.stdout.decode('utf-8').split('\n')
+
+for i, line in enumerate(output_list):
+    if not line:
+        continue
+    cog.out(line)
+    if i < len(output_list):
+        cog.out('\n')
+]]] -->
+Available recipes:
+    bootstrap
+    coverage *ARGS
+    lint
+    lock *ARGS
+    manage *COMMAND
+    test *ARGS
+    testall *ARGS
+    types *ARGS
+    docs:
+        build LOCATION="docs/_build/html" # Build documentation using Sphinx
+        serve PORT="8000"                 # Serve documentation locally
+<!-- [[[end]]] -->
+```
 
-The following setup steps assume you are using a Unix-like operating system, such as Linux or macOS, and that you have a [supported](https://django-bird.readthedocs.io/#requirements) version of Python installed. If you are using Windows, you will need to adjust the commands accordingly. If you do not have Python installed, you can visit [python.org](https://www.python.org/) for instructions on how to install it for your operating system.
+All commands below will contain the full command as well as its `just` counterpart.
 
-1. Fork the repository and clone it locally.
-2. Create a virtual environment and activate it. You can use whatever tool you prefer for this. Below is an example using the Python standard library's `venv` module:
+## Setup
 
-```shell
-python -m venv venv
-source venv/bin/activate
-```
+The following instructions will use `uv` and assume a Unix-like operating system (Linux or macOS).
 
-3. Install `django-bird` and the `dev` dependencies in editable mode:
+Windows users will need to adjust commands accordingly, though the core workflow remains the same.
+Alternatively, any Python package manager that supports installing from `pyproject.toml` ([PEP 621](https://peps.python.org/pep-0621/)) can be used. If not using `uv`, ensure you have Python installed from [python.org](https://www.python.org/).
 
-```shell
-python -m pip install --editable '.[dev]'
-# or using [just](#just)
+1. Fork the repository and clone it locally.
+2. Use `uv` too bootstrap your development environment:
+
+```bash
+uv python install
+uv sync --locked
+# or
 just bootstrap
 ```
 
-## Testing
+   This will install the correct Python version, create and configure a virtual environment, and install all dependencies.
+
+## Tests
 
-We use [`pytest`](https://docs.pytest.org/) for testing and [`nox`](https://nox.thea.codes/) to run the tests in multiple environments.
+The project uses [`pytest`](https://docs.pytest.org/) for testing and [`nox`](https://nox.thea.codes/) to run the tests in multiple environments.
 
 To run the test suite against the default versions of Python (lower bound of supported versions) and Django (lower bound of LTS versions), run:
 
-```shell
-python -m nox --session "test"
-# or using [just](#just)
+```bash
+uv run nox --session test
+# or
 just test
 ```
 
-To run the test suite against all supported versions of Python and Django, run:
+To run the test suite against the entire matrix of supported versions of Python and Django, run:
 
-```shell
-python -m nox --session "tests"
-# or using [just](#just)
+```bash
+uv run nox --session tests
+# or
 just testall
 ```
 
-## `just`
-
-[`just`](https://github.com/casey/just) is a command runner that is used to run common commands, similar to `make` or `invoke`. A `Justfile` is provided at the base of the repository, which contains commands for common development tasks, such as running the test suite or linting.
-
-To see a list of all available commands, ensure `just` is installed and run the following command at the base of the repository:
+Both can be passed additional arguments that will be provided to pytest:
 
-```shell
-just
+```bash
+uv run nox --session test -- -v --last-failed
+uv run nox --session tests -- --failed-first --maxfail=1
+# or
+just test -v --last-failed
+just testall --failed-first --maxfail=1
 ```

Justfile

@@ -5,7 +5,11 @@ mod docs ".just/documentation.just"
 
 [private]
 default:
-    @just --list
+    @just --list --list-submodules
+
+[private]
+cog:
+    uv run --with cogapp cog -r CONTRIBUTING.md
 
 [private]
 fmt:

README.md

@@ -390,6 +390,12 @@ GITHUB_APP = {
 
 Secret used to verify webhook payloads from GitHub.
 
+## Development
+
+For detailed instructions on setting up a development environment and contributing to this project, see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+For release procedures, see [RELEASING.md](RELEASING.md).
+
 ## License
 
 django-github-app is licensed under the MIT license. See the [`LICENSE`](LICENSE) file for more information.