Skip to content

Commit 1af5a4a

Browse files
authored
Update CONTRIBUTING.md
1 parent c29175d commit 1af5a4a

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,19 +51,15 @@ The project depends on some tools for the build process which are normally insta
5151
brew install [...]
5252
```
5353

54-
Git LFS is used to store UI test snapshots. `swift run tools setup-project` will already install it, however it can also be installed after a checkout by running:
54+
Git LFS is used to store UI and Preview test snapshots. `swift run tools setup-project` will already install it, however it can also be installed after a checkout by running:
5555

5656
```
5757
git lfs install
5858
```
5959

6060
### Snapshot Tests
6161

62-
If you make changes to the UI you may cause existing UI Snapshot tests to fail. You can run the snapshot tests using `UITests` target. To update the reference snapshots, delete them from `element-x-ios/UITests/Sources/__Snapshots__/Application` and run the tests again.
63-
These are the devices we store snapshots for that you will need to run against which need to use the iOS 16.4 simulator in en-US for consistency:
64-
- iPhone 14
65-
- iPad (9th generation)
66-
62+
If you make changes to the UI you may cause existing UI and Preview test snapshots to fail. The UITests run user flows and record snapshots while doing so using the settings defined under [checkEnvironments](https://github.com/element-hq/element-x-ios/blob/c29175d1f924e58b9646a200dbab0301fce3c258/UITests/Sources/Application.swift#L35-L37) while the PreviewTests use the settings defined in [PreviewTests.swift](https://github.com/element-hq/element-x-ios/blob/c29175d1f924e58b9646a200dbab0301fce3c258/PreviewTests/Sources/PreviewTests.swift#L18-L20). The snapshots are stored under `Sources/__Snapshots__` in their respective target's folder.
6763

6864
### Githooks
6965

0 commit comments

Comments
 (0)