Contributing - TabCarousel/TabCarousel GitHub Wiki

Wow, you want to contribute? That's awesome! Thanks!

To make things easier on you, here are some notes and guidelines.

Misc Notes

  • This was originally written on Chrome 12.0.742.100 on Mac OS X 10.6.4.
  • This is a Chrome extension. This is a tutorial if you're unfamiliar:
  • TabCarousel is currently a labor of love. @benjaminoakes originally made it because he thought it would be useful, but it's also used as a vehicle to try out new technologies. For example:
    • Getting experience with making Chrome extensions
    • Getting experience with Jasmine (outside of the normal browser workflow)
    • Getting experience with CoffeeScript (largely abandoned -- I find it easier to use, but not significantly enough to justify it turning away contributors)
    • Getting experience with Bootstrap
    • Getting experience with Backbone
    • More in the future...


To install the unreleased code from GitHub, you'll have to install the unpacked extension:

  • git clone this repo or your fork
  • Open chrome://extensions in your browser
  • On the right side of the page, toggle Developer Mode "on"
  • Choose "Load unpacked" and browse for the extracted files in dist. If you do not have dist, please see the process noted in Release Process.

If it is installed correctly, you'll see a new toolbar button. In most circumstances, you can edit the unpacked extension and see your changes take effect, but some changes (such as changing the manifest.json file) aren't reloaded.

Note: We are discussing removing the build step.


  • Looking for something to do? Acknowledged issues are a good place to start.
  • Fixing bugs you've found or adding features is also greatly appreciated!

Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • If you can, please add automated tests. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself that I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Additional Documentation