Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
126 lines (85 loc) · 4.55 KB

CONTRIBUTING.md

File metadata and controls

126 lines (85 loc) · 4.55 KB

How to contribute

Your contributions to Squeezer are very welcome. Exactly how to do that depends on what you want to do.

Reporting bugs and feature requests

Please use the issues page to report bugs or suggest new features.

It's appreciated if you take the time to see if someone else has already reported it, and if so, add a comment to their note.

Translations

The easiest way to contribute, especially if you are not a programmer, is to help translate Squeezer's interface in to different languages.

Follow How to contribute code to fetch the code and submit a pull request with your changes.

For a new translation copy Squeezer/src/main/res/values/strings.xml to a folder named Squeezer/src/main/res/values-<language>.

The language is defined by a two-letter ISO 639-1 language code, optionally followed by a two-letter ISO 3166-1-alpha-2 region code (preceded by lowercase r).

Translate the copied file, commit and submit a pull request with your changes.

Small bug fixes

If you've discovered a bug and want to fix it, or you'd like to have a go at fixing a bug that's already been reported, please go right ahead.

You can also review the list of open bugs if you want inspiration for something to work on.

The How to contribute code section has technical details on how to contribute code.

Larger features

Contributing larger features to Squeezer is also very welcome. For these please use the issues page, and let us know what you plan on working on, so we don't end up duplicating too much effort.

Please see the How to contribute code section for technical details.

How to contribute code

This guide assumes you have already downloaded and installed the Android SDK, in to a directory referred to as $SDK.

Fetch the code

Follow GitHub's instructions for forking the repository.

Checkout the code

We (roughly) follow the branching model laid out in the A successful Git branching model blog post.

Specifically:

  • The develop branch is for small bug fixes or other cleanups that need no more than a single commit to complete. Work is merged onto develop by the central maintainer. So, if you contribute please generate a pull request from your own new-branch-name (see below) to the maintainer's develop.

  • All other work happens on separate branches, branched from develop. Collaborative contributions to separate branches are made analogous: You generate a pull request from your personal branch to the according sub-branch of the maintainer.

  • When those branches are complete and ready for release they are merged on develop (by the central maintainer).

  • New releases are prepared by creating a release branch from develop and working there, before merging changes from the release back to develop and master.

Starting work

Suppose you want to start work on contributing a new feature. After fetching the repository checkout a new local branch from develop with:

git checkout -b new-branch-name develop

Then work on new-branch-name, pushing it up to GitHub as appropriate. Feel free to have discussions on the mailing list as you're working.

Keeping up to date with develop

As you're working other changes may be happening on the origin develop branch. Please use git rebase to pull in changes from develop to ensure your branch is up to date and that the future merge back in to develop is straightforward. To do that (assuming you have no open changes on your current branch):

git checkout develop  # Checkout the develop branch
git pull              # Fetch the most recent code
git checkout -        # Checkout the previous branch
git rebase develop    # Rebase current branch from develop

Android Studio configuration

  • Run Android Studio

  • If you have no projects open then choose "Import project" from the dialog that appears.

    If you already have a project open then choose File > Import Project...

  • In the "Select File or Directory to Import" dialog that appears, navigate to the directory that you fetched the Squeezer source code in ("android-squeezer").