Please read https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.md.
Element iOS support can be found in this room:
It's mandatory to have homebrew installed on your mac, and run after the checkout:
swift run tools setup-project
This will:
- Install various brew dependencies required for the project (like xcodegen).
- Set up git to use the shared githooks from the repo, instead of the default ones.
- Automatically run xcodegen for the first time.
We suggest using an Xcode version later than 15.0.1.
The Xcode project can be directly compiled through the shared ElementX scheme which includes the main application as well as the unit and UI tests.
The Xcode project itself is generated through xcodegen so any changes shouldn't be made directly to it but to the configuration files.
Dependencies will be automatically fetched through the Swift Package Manager, including a release version of the MatrixRustSDK. If you encounter issues while resolving the package graph please attempt a cache reset through File -> Packages -> Reset Package Caches.
To setup the RustSDK in local development mode run the following command
swift run tools build-sdk
This will clone a copy of the SDK if needed, build it for all supported architectures and configure ElementX to use the built framework. To learn about additional options run
swift run tools build-sdk --help
The project depends on some tools for the build process which are normally installed through swift run tools setup-project. Installing them manually though is as easy as copying what the script does
brew install [...]
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:
git lfs install
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.
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:
- iPhone 14
- iPad (9th generation)
The project uses its own shared githooks stored in the .githooks folder, you will need to configure git to use such folder, this is already done if you have run the setup tool with swift run tools setup-project otherwise you would need to run:
git config core.hooksPath .githooks
The project uses Localazy and is sharing its translations with the ElementX Android project: https://localazy.com/p/element
Please read the Android docs for more information about how this works. Note: On iOS we don't have the additional step of filtering strings per module.
ElementX uses Fastlane for running actions on the CI and tries to keep the configuration confined to either fastlane or xcodegen.
Please run bundle exec fastlane to see available options.
It's possible to debug the app's network traffic with a proxy server by setting the HTTPS_PROXY environment variable in the ElementX scheme to the proxy's address (e.g. localhost:8080 for mitmproxy).
Please see our pull request guide.
New screen flows are currently using the MVVM-Coordinator pattern. Please refer to the create screen template section.
Our changelog is automatically generated by GitHub, based on the PR title that you use when opening the issue. The changelog can be categorised by applying on of the pr- labels to your PR. The mapping of Label → Section can be found in the release.yml file. The contribution will be automatically credited to your GitHub username.
For Swift coding style we use SwiftLint to check some conventions at compile time (rules are located in the .swiftlint.yml file).
Otherwise please have a look to Apple Swift conventions. We are also using some of the conventions of raywenderlich.com Swift style guide.
We enforce the coding style by running checks on the CI for every PR through Danger, SwiftLint, SwiftFormat and SonarCloud
We also gather coverage reports on every PR through Codecov and will eventually start enforcing minimums.
Thank your for contributing to Matrix projects!