2
0
mirror of https://github.com/fork-maintainers/iceraven-browser synced 2024-11-07 15:20:38 +00:00
iceraven-browser/README.md
Björn Petersen e071984e41 [fenix] No Issue: Add pre-push hook instruction for PowerShell (https://github.com/mozilla-mobile/fenix/pull/4018)
The mklink command is not available in PowerShell, making the previous
documentation for pre-push hooks on Windows incomplete.
2019-07-15 16:04:45 -05:00

3.1 KiB

Firefox Preview

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

Getting Involved

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.

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

  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:assembleArmDebug
  1. Make sure to select the correct build variant in Android Studio: armDebug for ARM x86Debug for X86

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/