element-ios/CONTRIBUTING.md

1.8 KiB

Contributing code to Matrix

Please read the matrix-ios-sdk contributing guide.

Contributing code to Element iOS

I want to help translating

If you want to fix an issue for an English string, please submit a pull request to the Element iOS GitHub repository. If you want to fix an issue for another language, add a missing translation, or add a new language, please read Element Web translating guide first and then use the Element iOS Weblate.

If you have any question regarding translations please ask in Element Translation room.

Setting up a development environment

Please refer to the installation guide to setup the project.

Implement a new screen or new screen flow

New screen flows are currently using MVVM-Coordinator pattern. Please refer to the screen template Readme to create a new screen or a new screen flow.

Coding style

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.

Pull request

When you are making a pull request please read carefully the Pull Request Checklist.

Thanks

Thanks for contributing to Matrix projects!