Great to have you here! Here are a few ways you can help make this project better!
If you're reporting issues, you may request for TestFlight (beta) access via open.rocket.chat.
If you have a TestFlight pre-release installed you have following options:
- Open FLEX via Sidebar > Dropdown > My Account
- You can open the Menu and have a peek on the Network traffic if some action was not executing as promised
- Report issue via TestFlight directly, but Github Issues are preferred as everybody can see the Issues and may fix them.
In case you're interested in playing around with the code or giving something back, here are some instructions on how to set up your project:
- A macOS machine
- Xcode 9.3.x or higher (Swift 4.1)
(NOTE: Steps 3 and 4 must be executed from project's directory)
- Clone this repo:
git clone https://github.com/RocketChat/Rocket.Chat.iOS
- Install Bundler
sudo gem install bundler
To update Bundler (when there is new version available)
sudo gem update bundler
- Install all gem dependencies
bundle install (sudo might be required in some cases)
To update all gem dependencies (usually executed by maintainer) run
bundle update
To update pod's repository (in case of having those oudated compared to Podfile.lock and in case of pod install failure)
bundle exec pod repo update
- Download library dependencies using the cocoapods dependency manager (and update the same way):
bundle exec pod install
- Do NOT open the Xcode project directly, instead use the Rocket.Chat.xcworkspace file to open the Xcode workspace.
- Build the project by ⌘ + R
Also refer to Guidelines for modifying files.
You can skip installing Bundler (not recommended) and just install CocoaPods (note that you will need to install at least Ruby 2.2.3 for this to work). Make sure you have correct version of CocoaPods installed or you might be not able to build project properly.
sudo gem install cocoapods
Then you can call all the cocoapods actions without bundle exe command.
To update cocoapods (not that often needed, you will be notified during pod install when new version is available) run.
sudo gem update cocoapods
Didn't found a bug or want a new feature not already reported? Check out the issues with "help wanted" or other issues, for those no branch exists.
Don't change this file unless required (added files). This includes signing of the application itself. The "Team" will be red in the Rocket.Chat.xcodeproj, that's fine.
Search engines like Google help most of the times or consider searching on platforms like StackOverflow
We use swiftlint to enforce code style and best practices. Setup Xcode to use 4 spaces as indentation. For general styling refer to this Swift style guide.
Before opening a Pull Request/pushing to an existing PR run your code using the 🔧 Test (⌘ + U). If you're writing new code, testunits are welcome. Have a look at Rocket.ChatTests and increase our 
Test your changes on different device sizes (iPad/iPhone) and check if the layout is appropriate.
Also check if VoiceOver and different font sizes work well (Device Settings > General > Accessibility).
As soon as your changes are ready, you can open a Pull Request.
The title of the request should be descriptive, including either [NEW], [IMPROVEMENT] or [FIX] at the beginning, e.g. [FIX] App crashing on startup.
Also describe the changes you made on the message mentioning @RocketChat/ios. If there is an open issue which your changes will solve, include Closes/Fixes/Resolves #issue. For multiple issues repeat the sequence (Closes #issue1 #issue2 will only close #issue1 on merge).
You may share working results prior to finishing, please include [WIP] in the title. This way anyone can look at your code: you can ask for help within the PR if you don't know how to solve a problem.
If you are committing work in progress, please name your branche like some-branch-name-wip. The *-wip/wip-*/wip/* tells our CI to skip this branch for builds. Once you are ready, you can rename your branch and push your working commits (only a push will trigger CI). This makes it easier to save time and resources on continuous integration.
If working on docs or nothing related to the sourcecode of the App, you may want to name your branch *-docs/docs-*/docs/*. This has the same effect as wip above.
Your PR is automatically inspected by various tools, check their response and try to improve your code accordingly. Requests that fail to build or have wrong coding style won't be merged.