add some cursor rules

This commit is contained in:
counterweight 2025-12-20 19:09:33 +01:00
parent 820c01097c
commit eccad00513
Signed by: counterweight
GPG key ID: 883EDBAA726BD96C
3 changed files with 31 additions and 0 deletions

View file

@ -0,0 +1,9 @@
---
description: Coding standards that should be respect when working on Python code.
alwaysApply: false
---
- Use type hinting. Check regularly with mypy via the `Makefile` command `make typecheck`.
- Use docstrings following the style of the existing code.
- Avoid bloaty comments. Instead, favour using descriptive functions and variable names to make what's happening obvious.
- Use tests frequently to detect errors early. Make sure that tests are kept up to date. Remove dead code tests when removing code.