Skip to content

Install website dependencies before contributor paper checks #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wcook04 merged 1 commit into from
Oct 31, 2026
Merged

Install website dependencies before contributor paper checks #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,16 @@ author of a paper here and want it changed or removed, say so and it will be.
Data flows one way: `papers/<slug>/` to `tools/paper.py` to `web/public/papers/` to
`web/`. Keep the code free of knowledge of any one paper.

Install the [prerequisites in the README](README.md#run-the-site), then run
these commands from the repository root. Install the website dependencies
before checking a paper: the paper checker uses its Markdown and maths renderer.

```sh
npm ci --prefix web
python3 -m unittest discover -s tests
python3 tools/paper.py check contextual-embeddings
python3 tools/paper.py build
cd web && npm ci && npm run test:source && npm run build
cd web && npm run test:source && npm run build
```

`npm run check:source` checks that each reader source file has an entry point.
Expand Down