README: Contributing quickstart — hooks + local checks\n\nAdd a short blurb under Contributing that points newcomers to:\n- make hooks-install (pre-commit runs the containerised format-check),\n- SKIP_FORMAT_CHECK escape hatch for WIP commits,\n- make test-both and make lint to mirror CI locally.\n\nCONTRIBUTING.md remains the canonical detailed guide.

Author: flyingrobots

ACTIVITY.log.jsonl

@@ -125,3 +125,4 @@
 {"who": "AGENT", "what": "CMake: add add_nostdlib() and apply to all targets per instruction; remove exec gating and purity flags", "where": ["CMakeLists.txt"], "when": "2025-10-30T14:42:13Z", "why": "Align with requested linking policy (-nostdlib on lib + executables, MSVC-gated)", "how": "Introduced helper function and applied to gitledger, tests, and CLI; removed previous optional exec flag and compile purity tweaks", "protip": "This will likely break executable linking without CRT; proceeding as requested"}
 {"who": "AGENT", "what": "CMake policy: keep -nostdlib on library always; gate executables behind GITLEDGER_USE_NOSTDLIB (default OFF)", "where": ["CMakeLists.txt"], "when": "2025-10-30T15:00:34Z", "why": "Avoid broken CI while preserving library purity; provide an option to experiment with freestanding executables later", "how": "Added GITLEDGER_USE_NOSTDLIB option; helper now respects it; library gets unconditional -nostdlib (non‑MSVC)", "protip": "Flip -DGITLEDGER_USE_NOSTDLIB=ON locally to test freestanding exec linking once CRT lands"}
 {"who": "AGENT", "what": "Add and verify pre-commit hook running make format-check; install target hooks-install; docs updated", "where": ["Makefile", "tools/hooks/pre-commit", "CONTRIBUTING.md"], "when": "2025-10-30T18:39:40Z", "why": "Ensure local commits match CI clang-format policy and prevent style regressions before pushing", "how": "Added core.hooksPath install target, committed tools/hooks/pre-commit that dispatches make format-check in containers with host fallback and SKIP_FORMAT_CHECK escape; validated by running make format-check across matrix", "protip": "Run make hooks-install once per clone; temporarily bypass with SKIP_FORMAT_CHECK=1 for WIP commits; use make format to auto-fix"}
+{"who": "AGENT", "what": "Add quick Contributing blurb in README for hooks + local checks", "where": ["README.md"], "when": "2025-10-30T19:40:03Z", "why": "Surface pre-commit format gate and local matrix checks where newcomers look first", "how": "Extended README Contributing section with bullets: make hooks-install, SKIP_FORMAT_CHECK escape, make test-both + make lint; kept CONTRIBUTING.md as the canonical detail doc", "protip": "Install hooks once per clone; use containerised targets (make test-both, make lint) to match CI exactly"}

README.md

@@ -15,6 +15,10 @@ Early scaffolding for a Git-native ledger library built on top of `libgit2`.
 - Issue drafts can be copied from `docs/ISSUE-DRAFTS.md`; regenerate with `python3 tools/automation/generate_issue_drafts.py` after editing the breakdown.
 - Pull requests must follow `.github/pull_request_template.md` and exercise both build systems (CMake + Meson).
 - See `CONTRIBUTING.md` for detailed workflow expectations.
+- Quickstart for contributors:
+  - Install repo hooks once: `make hooks-install` (pre-commit runs `make format-check` in containers like CI).
+  - Temporarily bypass the format gate for a commit: `SKIP_FORMAT_CHECK=1 git commit -m "..."`.
+  - Before pushing, run `make test-both` and `make lint` to mirror the matrix locally.
 
 ## Building