Firefox for iOS

Getting involved

We encourage you to participate in this open source project. We love Pull Requests, Bug Reports, ideas, (security) code reviews or any kind of positive contribution. Please read the Community Participation Guidelines.

• IRC: #mobile for general discussion and #mobistatus for team status updates.
• Mailing list: [email protected].
• Bugs: File a new bug • Existing bugs

This is a work in progress on some early ideas. Don't get too attached to this code. Tomorrow everything will be different.

Likewise, the design and UX is still in flux. Don't get attached to them. They will change tomorrow! https://mozilla.invisionapp.com/share/HA254M642#/screens/63057282?maintainScrollPosition=false

GitHub issues are enabled on this repository, but we encourage you to file a bug (see above). We'll accept issues to track work items that don't yet have a pull request, and also as an early funnel for bug reports, but Bugzilla is the source of truth for lots of good reasons — issues will be shifted into Bugzilla, and pull requests need a bug number.

Building the code

As of July 2, 2015, this project requires Xcode 6.4. Make sure you upgrade, the App Store should offer you 6.4 already.

1. Install the latest Xcode developer tools from Apple.
2. Install Carthage.
3. Clone the repository:

git clone https://github.com/mozilla/firefox-ios

1. Pull in the project dependencies:

cd firefox-ios
sh ./checkout.sh

1. Open Client.xcodeproj in Xcode.
2. Build the Client scheme in Xcode.

It is possible to use App Code instead of Xcode, but you will still require the Xcode developer tools.

Contributor guidelines

Creating a pull request

• All pull requests must be associated with a specific bug in Bugzilla.
• If a bug corresponding to the fix does not yet exist, please file it.
• You'll need to be logged in to create/update bugs, but note that Bugzilla allows you to sign in with your GitHub account.
• Use the bug number/title as the name of pull request. For example, a pull request for bug 1135920 would be titled "Bug 1135920 - Create a top sites panel".
• Finally, upload an attachment to the bug pointing to the GitHub pull request.

1. Click Add an attachment.
2. Next to File, click Paste text as attachment.
3. Paste the URL of the GitHub pull request.
4. Enter "Pull request" as the description.
5. Finally, flag the pull request for review. Set the review field to "?", then enter the name of the person you'd like to review your patch. If you don't know whom to add as the reviewer, click suggested reviewers and select a name from the dropdown list.

Pro tip: To simplify the attachment step, install the Github Bugzilla Tweaks addon. This will add a button that takes care of the first four attachment steps for you.

Swift style

• Swift code should generally follow the conventions listed at https://github.com/raywenderlich/swift-style-guide.
  • Exception: we use 4-space indentation instead of 2.

Whitespace

• New code should not contain any trailing whitespace.
• We recommend enabling both the "Automatically trim trailing whitespace" and "Including whitespace-only lines" preferences in Xcode (under Text Editing).
• git rebase --whitespace=fix can also be used to remove whitespace from your commits before issuing a pull request.

Commits

• Each commit should have a single clear purpose. If a commit contains multiple unrelated changes, those changes should be split into separate commits.
• If a commit requires another commit to build properly, those commits should be squashed.
• Follow-up commits for any review comments should be squashed. Do not include "Fixed PR comments", merge commits, or other "temporary" commits in pull requests.

Adding new dependencies with Carthage

Notes from Stefan:

Usually Carthage is used to compile frameworks and then include the (compiled) binary frameworks in your app. When you do this, the frameworks do not need to be signed by Carthage. Instead, at the end of building the your application, xcode will simply sign all the embedded resources, frameworks included. So as long as signing works for your app, it will work for frameworks imported with Carthage.

But, because not all Carthage dependencies can be compiled to frameworks yet, we currently include them as source. This means they become dependent projects of our application, which in turn means that they are built and signed individually as part of the build process of our app.

Now this is where it gets tricky. Because code signing on iOS can get really tedious to get right. Small mistakes in dependent projects can turn into issues about code signing identities, missing provisioning profiles, etc.

For example:

If a dependent project has a team identifier set, Xcode will complain that it cannot find signin identities of that team. It is best to set the team to None.

If a dependent project is configured to use a Distribution Code Signing Identity for a Release build, Xcode will complain that such a profile is not available. (Since we only have development profiles on our workstations). It is best to configure both Debug and Release Build Configurations to use the automatic "iPhone Developer" Code Signing Identity. This will pick the right thing on your local build.

Most of this is fixable and can be reported upstream.

If you add a new dependency, ping @st3fan and he'll make sure things work correctly on our integration (xcode server) and dogfood builders.

A command exists to make adding dependencies less painful: ./update.sh. .