Begin Developing

Get Started Developing for Refinery

Setup

Go here http://tutorials.refinerycms.org/tutorials/how-to-contribute-to-refinery-development if you need help getting the source checked out.

Frequently Asked Questions

Where are all the files? There's practically nothing in the app/ folder!

RefineryCMS is arranged into a series of engines. Most likely what you're looking for can be found in another directory.

Do I need to generate an app with the gem every time I make a change to test it?

Nope! Through some magical trickery the repository itself is almost exactly the same as what would be generated from the gem. Therefore, you can run rails server and test your changes in place.

What are the differences between what's generated from the gem and what's in the repository?

The only differences are that the repository contains some extra files for generating the gemspec, running tests, etc. Also, instead of loading the engines from rubygems, it gets them locally due to this line in the Gemfile: gem 'refinerycms', :path => '.'

Is anyone available to help me with my contribution?

Absolutely! This is the reason we have so many contributors, we love any help that people can provide. We even taught a contributor git from scratch, and now he's on the core team. The two best places to get help are the IRC channel and the Google Group:

• irc://irc.freenode.net/refinerycms - #refinerycms on freenode.net is our IRC channel. There is usually a core member there all day during the week and at least someone who can help on evenings and weekends.
• http://group.refinerycms.org - Google Group