Home

Overview

Welcome to the Firefox iOS Wiki! This space is for contributors and maintainers to find technical documentation, development guides, and project resources.

🚀 Getting Started

• Build Instructions
• Contribution Guidelines
• Pull Requests
• Naming PRs

🏗 Architecture

• Application Overview
• UI Component Library
• Navigation & Coordinators

Redux

• Redux
• How to implement
• Guidelines + FAQs

Application Services

• Application Services dependency for Developers
• Notification Service

🔧 Development

• Code Style
• How to use SwiftUI
• How to use Swift Concurrency
• A Brief Overview of Accessibility
• Theming System and Themeable Protocol

Localization

• How to add and modify Strings
• Import and Export with Localization Tools

Logging

• Logging Strategy
• How to get your device logs
• How to get your device database

Telemetry

• Adding Glean Telemetry Events and Metrics
• Testing Glean

Feature Overviews

The documentation found here is best thought of as an informative mental map of the feature discussed, rather than a complete breakdown of the code; for that, you should dig into the code itself. However, these documents will allow you to understand the ideas and intentions behind how some features were designed, and how to use them easily.

• Contextual Feature Recommender
• Enhanced Tracking Protection
• Search Engines
• Top Sites/Shortcuts
• Sponsored tiles
• Wallpapers

Technical topics

• Working with BrowserKit
• Feature Branch Workflow
• Event Queue
• Window Management
• When to use extensions
• Simulating Default Browser Behavior in Debug Mode
• Code Benchmarking
• Notifiable Protocol

Nimbus

• What's a Nimbus
• Nimbus Features
• Feature Flags

Webviews

• How to work on the WebEngine
• How to trigger WKUIDelegate methods
• Run local server to test websites locally
• WKWebView navigation and security considerations

📦 Releases

• Release checklist
• Bitrise overview
• Retry Bitrise Pipeline
• Release & Nightly CI workflows
• Health Monitoring
• Requesting an uplift to a release branch

CI system - Bitrise

• Bitrise General Overview
• Bitrise Builds & Pipelines - How to Rebuild

Crash Reporting

• Sentry

🧪 Testing

Unit tests

• Why and how to write Unit tests
• Unit Test Guidelines
• Feature Flag Unit Testing
• Mocking Redux Middlewares
• Telemetry Unit Testing

UI tests

• Writing your first XCUI test
• Screenshot Tests
• FxScreenGraph and XCUITest
• Sync Integration Tests
• Automated UI Testing
• Performance Tests

Other

• QA Testing Process
• Firefox iOS Test Types
• Manual testing