Skip to content

Hacking on Autotune

Ryan Mark edited this page Apr 8, 2016 · 1 revision

Do you want to fix some bugs, or add some features to Autotune? You totally rock! First drop us a line at via the feedback form, and read our contribution guidelines.

First setup a Rails project

You'll need to setup Autotune for yourself using our setup instructions. These instructions will setup a new Rails project and will load the Autotune gem in a way thats difficult to develop on.

Make the project a git repo

Your new project needs to be a git repo. You don't have to push it to a server, but why not github?

cd my-autotune-project
git init
git add .
git commit -m "Initial commit"

Add Autotune as a submodule

Now that you have a git repo, you can move the Autotune gem from where ever your gems are kept into a subfolder of your Rails project by using a submodule.

If you do not have write access to the original voxmedia repo, you should first fork autotune to your personal account or to an organization account that you have access to.

Then add the Autotune repo as a submodule:

git submodule add https://github.com/YOUR-NAME-HERE/autotune.git autotune

This will download the edge version of Autotune into an autotune folder in your Rails project. Then update your Gemfile.

Change this line:

gem 'autotune', git: 'https://github.com/voxmedia/autotune.git'

to this:

gem 'autotune', path: './autotune'

Now run bundle install to update the Gemfile.lock file, then add and commit your changes with git.

You can now start hacking, and have all the necessary in the same folder and make changes to autotune and your Rails project in concert.

If you're not familiar with how to use submodules, read up on them here.