fix(docs): fix formatting issues in README.md

- adapt meta-/code-/obs- rules to the local Python benchmark pipeline
- replace db-sql-ddl, code-config-env-scope, test-e2e-pytest with pipeline equivalents
- add code-python-style, data-determinism, data-naming-units, bench-methodology, build-pipeline-tasks
- normalize specs and README typography to ASCII per code-data-formatting
- rewrite root CLAUDE.md trigger table; add .cursorrules and .gitignore
- specs: pipeline plan and task specs 00-11
- rules: 19 binding rule files adapted for this project
- docs: CLAUDE.md rule-trigger table
- config: .cursorrules commit convention, .gitignore excluding out/ and .venv/
- docs: rewrite README.md with pipeline diagrams, setup guide, result placeholders
- config: requirements.txt for the closed dependency list
- datagen: make_lab_config.py writes out/config/lab_config.yaml and .done marker
This commit is contained in:
administrator
2026-07-11 13:39:13 -04:00
parent d8353953b0
commit b173ac82a9
55 changed files with 3755 additions and 9 deletions

48
.cursorrules Normal file
View File

@@ -0,0 +1,48 @@
# Cursor rules for LabDataStorageEvaluation
## Commit messages (mandatory format)
Every commit message you generate MUST follow this convention exactly.
First line: type(scope): description
- lowercase imperative English summary, under 72 characters, no trailing period
- type is one of (closed list): feat fix perf refactor security docs ci chore test
- scope is one of (closed list): specs rules docs config datagen convert bench report tools all
Scope selection by changed files:
- specs = docs/specs/**
- rules = docs/rules/**
- docs = other prose docs (README.md, CLAUDE.md, docs/examples/**)
- config = configuration files (.gitignore, .cursorrules, editable YAML defaults)
- datagen = lab-configuration and data-generation code (tasks 01-03)
- convert = format converters: JSON-LD, SQLite, PostgreSQL, RDF (tasks 04-07)
- bench = benchmark queries, runner, extrapolation (tasks 08-10)
- report = reporting code and templates (task 11)
- tools = helper scripts under tools/
- all = multiple areas, or when no narrower scope honestly fits
Body: the subject is only a title. If the diff touches more than one area,
add a blank line and 2-6 concise bullets covering every meaningful changed
area. Split unrelated work into separate commits.
Special forms allowed as-is: "Merge ..." commits; "release(scope): vX.Y.Z".
Never emit vague or unprefixed subjects such as: "Update files",
"Improve project", "clarify rules", "changes".
Examples of good subjects:
- feat(datagen): stream friction cycle rows during CSV generation
- fix(convert): match sqlite row counts against MANIFEST before commit
- docs(rules): add benchmark methodology rule
- chore(config): ignore out/ artifact tree
## Typography
Use plain ASCII typography in everything you write into this repository:
hyphen-minus instead of en/em dashes, straight quotes, three dots instead
of the ellipsis character. See docs/rules/code-data-formatting.md.
## Python
Python code in this repository uses TABS for indentation. See
docs/rules/code-python-style.md for the closed dependency list.