infra/paperspec
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: documents and session tokens
check / check (default, macos-latest) (push) Canceled after 0s
Details
check / check (default, ubuntu-latest) (push) Canceled after 0s
Details
check / check (py310, macos-latest) (push) Canceled after 0s
Details
check / check (py310, ubuntu-latest) (push) Canceled after 0s
Details

Browse Source
This commit is contained in:
alexm committed 2026-10-12 01:07:50 -04:00
1 parent 62f54ed869
commit 8b2df58266
39 files changed
+1523 -199
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CONTRIBUTING.md
+11 -4
View File
@@ -3,23 +3,30 @@
## One fix, one test
Every change to a rule comes with the vector or fixture that shows it.
Change the oracle in `tools/oracle/` and the chapter together, run `python3 tools/build.py` to regenerate the vectors and fixtures, and commit the regenerated files with the change.
`python3 tools/check.py` must pass.
Change the oracle in `tools/oracle/` and the chapter together, run `pixi run build` to regenerate the vectors and fixtures, and commit the regenerated files with the change.
`pixi run check` must pass.
Without pixi, run `python3 tools/build.py` and `python3 tools/check.py`, and lint the Markdown with markdownlint-cli2.
A fixture that breaks something belongs in `fixtures/invalid/`, with the rule it breaks in `expect.json`, built by `tools/build.py` like the others.
## The environment
`pixi.toml` pins the development environment: Python, the `jsonschema` package and markdownlint-cli2, from conda-forge.
Commit `pixi.lock` whenever pixi updates it, so that CI and every contributor solve the same environment.
`pixi run -e py310 check` runs the checks on the oldest supported Python.
Rule IDs are stable: a rule's meaning never changes, and a retired ID is never reused.
## Versions
A change that makes a valid file invalid, or changes any computed value, is breaking: it needs a new major version of the format and a migration in `scienting-core`.
Adding an optional property, a kind or an enumeration value is a minor change.
Record each change in [CHANGELOG.md](CHANGELOG.md), and each departure from the design in [DECISIONS.md](DECISIONS.md).
Record each change in [CHANGELOG.md](CHANGELOG.md), and explain any rule that a reader may question in [docs/rationale.md](docs/rationale.md).
## Prose
US English, one sentence per line, so a change to a sentence is a one-line diff.
Prefer plain words to abbreviations; write "for example", not "e.g.".
`tools/check.py` lints both, and `markdownlint` checks the Markdown.
`tools/check.py` lints both, and `pixi run lint` checks the Markdown with markdownlint-cli2.
## Data