1
0
Fork 0
 
 
 
 
 
 
Go to file
Johan Lorenzo 6a8f7224dc
Bug 1580778 - Migrate build tasks to taskgraph and retire the old decision task (#5488)
2019-09-24 12:52:05 +02:00
.github Adds SUMO verification step 2019-09-20 10:08:32 -07:00
app Import strings from android-l10n (#5482) 2019-09-23 19:53:57 -07:00
architecture fix: dex error on UI test job 2019-08-29 18:14:20 -07:00
automation Bug 1580778 - Migrate build tasks to taskgraph and retire the old decision task (#5488) 2019-09-24 12:52:05 +02:00
buildSrc No bug - Add WebCompat feature. 2019-09-20 08:33:48 -07:00
certificates Adds certificates to repository 2019-05-20 19:35:29 -07:00
config For #4326 - Updates codebase to support latest version of detekt 2019-08-21 13:50:51 -07:00
docs For #5312 - Add Telemetry for Tracking Protection 2019-09-23 08:29:45 -07:00
fastlane Adding l10n screenshot tests for Fenix (#3562) 2019-07-08 11:00:29 -05:00
gradle/wrapper Closes #2683. Update Gradle to `5.5` (#3929) 2019-07-08 11:14:13 -05:00
taskcluster Bug 1580778 - Migrate build tasks to taskgraph and retire the old decision task (#5488) 2019-09-24 12:52:05 +02:00
.adjust_token Fixes #675: Integrate Adjust SDK (for Greenfield flavor) 2019-03-01 12:57:59 -06:00
.cron.yml Bug 1580778 - Migrate build tasks to taskgraph and retire the old decision task (#5488) 2019-09-24 12:52:05 +02:00
.editorconfig For #4326 - Updates codebase to support latest version of ktlint 2019-08-21 13:50:51 -07:00
.gitattributes Adds a gitattribute file to manage changelog merges 2019-04-11 15:02:16 -05:00
.gitignore Bug 1580778 - Migrate build tasks to taskgraph and retire the old decision task (#5488) 2019-09-24 12:52:05 +02:00
.taskcluster.yml Let taskgraph load tasks for raptor 2019-09-16 11:36:07 +02:00
CODE_OF_CONDUCT.md Add Mozilla Code of Conduct file 2019-03-31 10:29:27 -07:00
Gemfile Adding l10n screenshot tests for Fenix (#3562) 2019-07-08 11:00:29 -05:00
LICENSE Fixes #163: Add LICENSE 2019-01-16 11:26:46 -06:00
README.md No issue: cleaned up formatting on Build Variants section of readme 2019-09-19 15:08:09 -07:00
build.gradle For #4064: Old R8 & keep rules are inhibiting optimizations (#4930) 2019-08-29 10:16:26 -05:00
codecov.yml No issue: Add threshold to codecov (#4751) 2019-08-15 10:40:05 -07:00
debug.keystore For #1601 - Bookmark icon should change visually if page is bookmarked 2019-04-25 17:29:27 -07:00
gradle.properties Configure either geckoview beta or nightly at compile-time (#4851) 2019-08-21 08:32:01 -07:00
gradlew Initializes Android project 2018-12-07 15:25:38 -05:00
gradlew.bat Initializes Android project 2018-12-07 15:25:38 -05:00
l10n.toml Import strings from android-l10n 2019-08-19 19:14:22 -07:00
settings.gradle Consume new `substitute-local-geckoview.gradle` script from Bug 1533465. 2019-08-21 19:52:01 +02:00

README.md

Firefox Preview

Task Status codecov

Firefox Preview (internal code name: "Fenix") is an all-new browser for Android, based on GeckoView and Mozilla Android Components.

I want to open a Pull Request!

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

Since we are a small team, however, we do not have the bandwidth to review unsolicited PRs. Please follow our Pull Request guidelines, or we may close the PR.

To make it easier to review, we have these PR requirements:

  • Every PR must have exactly one issue associated with it.
  • Write a clear explanation of what the code is doing when opening the pull request, and optionally add comments to the PR.
  • Make sure there are tests - or ask for help on how the code should be tested in the Issue!
  • Keep PRs small and to the point. For extra code-health changes, either file a separate issue, or make it a separate PR that can be easily reviewed.
  • Use micro-commits. This makes it easier and faster to review.
  • Add a screenshot for UX changes (this is part of the PR checklist)

As a small team, we have to prioritize our work, and reviewing PRs takes time. We receive lots of PRs every day, so if you can keep your PRs small, it helps our small team review and merge code faster, minimizing stale code.

Keep in mind that the team is very overloaded, so PRs sometimes wait for a very long time. However this is not for lack of interest, but because we find ourselves in a constant need to prioritize certain issues/PRs over others. If you think your issue/PR is very important, try to popularize it by getting other users to comment and share their point of view.

Getting Involved

Before you attempt to make a contribution please read the Community Participation Guidelines.

Beginners! - Watch out for Issues with the "Good First Issue" label. These are easy bugs that have been left for first timers to have a go, get involved and make a positive contribution to the project!

Build Instructions

Note: Both Android SDK and NDK are required.

  1. Clone or Download the repository:
git clone https://github.com/mozilla-mobile/fenix
  1. Import the project into Android Studio or build on the command line:
./gradlew clean app:assembleGeckoBetaDebug

Use app:assembleGeckoNightlyDebug to build with the Gecko Nightly version instead.

  1. Make sure to select the correct build variant in Android Studio. See the next section.

Guide to Build Variants

We have a lot of build variants. Each variant is composed of two flavors. One flavor is the version of Gecko to use and the other describes which app id and settings to use. Here is a description of what each means:

  • geckoBeta (recommended) uses the Beta variant of the Gecko rendering engine, which corresponds to the next version of Gecko which will go to production
  • geckoNightly uses the Nightly variant of the Gecko rendering engine, which is the version which will arrive after beta and is less stable


  • debug uses debug symbols and debug signing, adds tools like LeakCanary for troubleshooting, and does not strip unused or wasteful code
  • fenixNightly is a release build with nightly signing which uses the org.mozilla.fenix.nightly app id for nightly releases to Google Play
  • fenixNightlyLegacy is a release build with release signing which uses the org.mozilla.fenix production app id along with nightly logos, which we're trying to phase out
  • fenixBeta is a release build with beta signing which uses the org.mozilla.fenix.beta app id for beta releases to Google Play
  • fenixProduction is a release build with release signing which uses the org.mozilla.fenix app id for production releases to Google Play
  • fennecProduction is an experimental build with release signing which uses the org.mozilla.firefox app id and supports upgrading the older Firefox. WARNING Pre-production versions of this may result in data loss.
  • forPerformanceTest is a release build with the debuggable flag set and test activities enabled for running Raptor performance tests

Pre-push hooks

To reduce review turn-around time, we'd like all pushes to run tests locally. We'd recommend you use our provided pre-push hook in config/pre-push-recommended.sh. Using this hook will guarantee your hook gets updated as the repository changes. This hook tries to run as much as possible without taking too much time.

To add it on Mac/Linux, run this command from the project root:

ln -s ../../config/pre-push-recommended.sh .git/hooks/pre-push

or for Windows run this command using the Command Prompt with administrative privileges:

mklink .git\hooks\pre-push ..\..\config\pre-push-recommended.sh

or using PowerShell:

New-Item -ItemType SymbolicLink -Path .git\hooks\pre-push -Value (Resolve-Path config\pre-push-recommended.sh)

To push without running the pre-push hook (e.g. doc updates):

git push <remote> --no-verify

License

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/