mirror of
https://github.com/fork-maintainers/iceraven-browser
synced 2024-11-17 15:26:23 +00:00
63 lines
2.4 KiB
Markdown
63 lines
2.4 KiB
Markdown
|
# Firefox Fenix
|
||
|
|
|
||
|
|
Firefox Fenix is a new browser for Android
|
||
|
|
|
||
|
|
## 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](https://www.mozilla.org/en-US/about/governance/policies/participation/).
|
||
|
|
|
||
|
|
* [Guide to Contributing](https://github.com/mozilla-mobile/shared-docs/blob/master/android/CONTRIBUTING.md) (**New contributors start here!**)
|
||
|
|
|
||
|
|
* [View current Issues](https://github.com/mozilla-mobile/fenix/issues), [view current Pull Requests](https://github.com/mozilla-mobile/fenix/pulls), or [file a security issue][sec issue].
|
||
|
|
|
||
|
|
* IRC: [#focus (irc.mozilla.org)](https://wiki.mozilla.org/IRC) | [view logs](https://mozilla.logbot.info/fenix/)
|
||
|
|
(**We're available Monday-Friday, GMT and PST working hours**).
|
||
|
|
|
||
|
|
* [View the Wiki](https://github.com/mozilla-mobile/fenix/wiki).
|
||
|
|
|
||
|
|
**Beginners!** - Watch out for [Issues with the "Good First Issue" label](https://github.com/mozilla-mobile/fenix/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). 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:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
git clone https://github.com/mozilla-mobile/fenix
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Import the project into Android Studio **or** build on the command line:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
./gradlew clean app:assembleArmDebug
|
||
|
|
```
|
||
|
|
|
||
|
|
3. 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, run this command from the project root:
|
||
|
|
```sh
|
||
|
|
ln -s ../../config/pre-push-recommended.sh .git/hooks/pre-push
|
||
|
|
```
|
||
|
|
|
||
|
|
To push without running the pre-push hook (e.g. doc updates):
|
||
|
|
```sh
|
||
|
|
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/
|