Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

docs: add instructions on updating snapshots

Wenzhao Hu2cce32e1bd1e
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4283fca958..1694ceddb7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -183,6 +183,11 @@ and then run the following command to run E2E tests:
pnpm test:e2e
```
+### Update Snapshots
+
+Univer uses Playwright to perform visual comparison tests. If you have made changes to the UI, the CI may fail due to visual differences. You can update the snapshots by commenting the PR with `/update-snapshots` like [this](https://github.com/dream-num/univer/pull/3655#issuecomment-2398951289), or you can run this GitHub Action [📸 Manually Update Snapshots · Workflow runs · dream-num/univer (github.com)](https://github.com/dream-num/univer/actions/workflows/update-snapshots-manually.yml) manually.
+
+
### Clean code
> Programs are meant to be ready by humans and only incidentally for computers to execute. - Harold Abelson