Refactoring/improve comments and readme #46

	name: Lint, format, type-check
	on:
	# Rebuild any PR to main and push changes to main
	pull_request:
	branches:
	- main
	push:
	branches:
	- main
	workflow_dispatch:
	inputs:
	logLevel:
	description: 'Log level'
	required: true
	default: 'warning'
	type: choice
	options:
	- info
	- warning
	- debug
	jobs:
	lint-format-typecheck:
	runs-on: ubuntu-latest
	steps:
	- name: Checkout repository
	uses: actions/checkout@v4

	- name: Login to GitHub Container Registry
	uses: docker/login-action@v3
	with:
	registry: ghcr.io
	username: ${{ github.repository_owner }}
	password: ${{ secrets.GH_DEVCONTAINER_TOKEN }}

	- name: Cache venv
	uses: actions/cache@v4
	with:
	path: ./.venv
	key: venv-${{ hashFiles('poetry.lock') }}

	- name: Build and run dev container task
	uses: devcontainers/[email protected]
	with:
	imageName: ghcr.io/${{ secrets.GH_DOCKER_REGISTRY_NAMESPACE }}/${{ vars.CONTAINER_IMAGE_NAME }}
	# Push new container image if `eventFilterForPush` and `refFilterForPush` (by default allow all branches to trigger a push of the container image) are true
	push: filter
	# Push new image only if event name that triggered this workflow matches `push`
	# If a pull request triggered it, then skip pushing new container image to registry
	eventFilterForPush: push
	runCmd: \|
	poetry run ruff check --fix
	poetry run ruff format .
	poetry run mypy src tests

Provide feedback