From c63a52b79447ab98e19c4f12d857844d8aa89720 Mon Sep 17 00:00:00 2001 From: Ayo Date: Sat, 20 Jun 2026 12:00:28 +0200 Subject: [PATCH] chore: update CONTRIBUTING for commands & key files --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e00ccbd34..2d7440bd1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,3 +28,18 @@ tests as well (see the `kitty_tests/` sub-directory for existing tests, which can be run with `./test.py`). That's it. + +### Commands + +- **Build:** `./dev.sh build` or `python3 setup.py build --debug` +- **Tests:** `./test.py` (or `--module ` for specific) +- **Type check:** `./test.py type-check` (mypy) +- **Linting:** `ruff check .` for Python, `gofmt/gofmt` for Go +- **Regenerate config types:** `./gen-config.py` after editing `definition.py` +- **CI runs:** GCC + Clang on Python 3.11/3.12/3.13 (ASAN enabled), ruff linting, mypy, go vet + +### Key files to know first when working on the project +- `boss.py` — central runtime controller +- `screen.c` — VT terminal emulation core +- `kitty/options/definition.py` — all config options in one place (~3700 lines) +- `child-monitor.c` — child process/PTY management