Update project dev documentation (#51)

## Changes

This PR contains some minor updates for the project:

 - Git should ignore the virtual environment from Hatch.
- Workaround an IntelliJ/PyCharm issue by specifying the full path to
the python interpreter when running `make dev`.
 - EditorConfig settings.
- Type hints in the README generator to eliminate a warning during `make
lint`.

Author: asnare

.editorconfig

@@ -0,0 +1,19 @@
+# Top-most EditorConfig file.
+root = true
+
+# Universal settings.
+[*]
+indent_style = space
+indent_size = 4
+tab_width = 8
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[Makefile]
+indent_style = tab
+indent_size = tab
+
+[*.{json,yml}]
+indent_size = 2

.gitignore

@@ -1,9 +1,10 @@
-.idea
+.idea/
+.venv/
 *.iml
 *.pyc
 .pytest_cache
 *.egg-info
 tests/**/build
 .coverage
 coverage.xml
-pytester.iml
+pytester.iml

CONTRIBUTING.md

@@ -242,7 +242,7 @@ make dev
 
 To use different python version, specify it in `HATCH_PYTHON` variable:
 ```shell
-HATCH_PYTHON=python3.10 make clean dev test
+HATCH_PYTHON=$(which python3.10) make clean dev test
 ```
 
 Configure your IDE to use `.venv/bin/python` from the virtual environment when developing the project:

scripts/gen-readme.py

@@ -61,8 +61,8 @@ def overwrite_readme(part, docs):
         f.write(new_readme)
 
 
-def discover_fixtures():
-    fixtures = []
+def discover_fixtures() -> list[Fixture]:
+    fixtures: list[Fixture] = []
     see_also = collections.defaultdict(set)
     idx: dict[str, int] = {}
     for fixture in P.__all__:

tests/resources/hatchling-whl/pyproject.toml

@@ -10,10 +10,9 @@ requires-python = ">=3.7"
 license = "MIT"
 keywords = []
 authors = [
-  { name = "Jonh Doe", email = "[email protected]" },
+    { name = "Jonh Doe", email = "[email protected]" },
 ]
 dependencies = []
 
 [tool.hatch.version]
 path = "src/hatchling_whl/__about__.py"
-