The FrostWire Monorepo
- /android Sources for FrostWire for Android
- /desktop Sources for FrostWire for Desktop (Windows, Mac, Linux)
- /common Common sources for the desktop and android client
- /telluride Sources for our Telluride cloud video downloader
- Keep it simple, stupid. (KISS)
- Do not repeat yourself. (DRY) Re-use your own code and our code. It'll be faster to code, and easier to maintain.
- If you want to help, the Issue tracker is a good place to take a look at.
- Try to follow our coding style and formatting before submitting a patch.
- All pull requests should come from a feature branch created on your git fork. We'll review your code and will only merge it to the master branch if it doesn't break the build. If you can include tests for your pull request you get extra bonus points ;)
- When you submit a pull request try to explain what issue you're fixing in detail and how you're fixing in detail it so it's easier for us to read your patches. If it's too hard to explain what you're doing, you're probably making things more complex than they already are. Look and test your code well before submitting patches.
- We prefer well named methods and code re-usability than a lot of comments. Code should be self-explanatory.
If you want to contribute code, start by looking at the open issues on github.com.
If you want to fix a new issue that's not listed there, create the issue, see if we can discuss a solution.
Please follow the following procedure when creating features to avoid unnecessary rejections:
Do this the first time (Cloning & Forking):
- Clone https://github.com/frostwire/frostwire to your computer. This will be the
git clone https://github.com/frostwire/frostwire
- Make a Fork of the
originrepo into your github account.
- On your local copy, add your fork as a remote under your username as the remote alias.
cd frostwire git remote add your_github_username_here https://github.com/your_github_username_here/frostwire
For further contributions
- Create a branch with a descriptive name of the issue you are solving.
- Make sure the name of your feature branch describes what you're trying to fix. If you don't know what to name it and there's an issue created for it, name your branch issue-233 (where 233 would be the number of the issue you're fixing).
- Focus on your patch, do not waste time re-formatting code too much as it makes it hard to review the actual fix. Good patches will be rejected if there's too much code formatting noise, we are a very small team and we can't waste too much time reviewing if something got lost or added in the middle of hundreds of lines that got shifted.
- Code, Commit, Push, Code, Commit, Push, until the feature is fully implemented.
- If you can add tests to demonstrate the issue and the fix, even better.
- Submit a pull request that's as descriptive as possible. Adding (issue #233) to the commit message or in PR comments automatically references them on the issue tracker.
- We'll code review you, maybe ask you for some more changes, and after we've tested it we'll merge your changes.
If your branch has taken a while to be accepted for merging into
master, it's very likely that the
master branch will have moved forward while you work. In this case, make sure to sync your
git fetch upstream master
and then rebase your branch to bring it up to speed so it can be merged properly (do not merge
master into your branch):
git checkout my-branch git rebase origin/master
As you do this you may have to fix any possible conflicts, just follow the instruction git gives you if this is your first time.
Make sure to squash any cosmetic commits into the body of your work so that we don't pollute the history.
Repeat and rinse, if you send enough patches to demonstrate you have a good coding skills, we'll just give you commit access on the real repo and you will be part of the development team.
How to build
To build you will need the Java Developer Kit 19
Additional Desktop requirements
If you want to work with the translation (i18n) bundles, you will need to install
gettext to perform the text extraction and bundling tasks (
If you are on Mac,
gettext installation is very simple with brew:
brew install gettext.
If you are on Ubuntu,
gettext installation can be done with
sudo apt install gettext.
If you are developing in Windows we recommend you work with MinGW and install the
We also recommend you use git for window's terminal instead of
cmd.exe. All of our scripts will work as if you were working in Linux/Mac. Git's terminal supports window resizing, more convenient copying and pasting,
Tab text completion,
Ctrl+R reverse search, common bash keyboard shortcuts and basic GNU tools right out of the box.
Build with Android studio or go inside the
android directory and type:
./gradlew assembleDebug, debug builds will be created inside the
Frostwire Desktop and Frostwire Android are offered under the GNU General Public License.