adding a note about contributing
Oleg
committed Mar 22, 2011
commit 9b614548e77ad602a966a09c88f6cc5175f771b1
Showing 1
changed file with
12 additions
and 7 deletions
README.md
+12
-7
| @@ | @@ -1,5 +1,5 @@ |
| - | Comfortable Mexican Sofa (MicroCMS) |
| - | =================================== |
| + | ComfortableMexicanSofa (MicroCMS) |
| + | ================================= |
| ComfortableMexicanSofa is a tiny and powerful micro CMS for your Rails 3 application. This CMS is a plugin for your application, not the other way around. Implemented as an Engine so installation is no different than for any other plugin out there. | |
| @@ | @@ -89,7 +89,7 @@ Sofa is able to manage multiple sites from the same application. For instance: ' |
| Integrating CMS with your app | |
| ----------------------------- | |
| - | Comfortable Mexican Sofa is a plugin, so it allows you to easily access content it manages. Here's some things you can do. |
| + | ComfortableMexicanSofa is a plugin, so it allows you to easily access content it manages. Here's some things you can do. |
| You can use your existing application layout. When creating CMS layouts there's an option to use an application layout. Suddenly all CMS pages using that layout will be rendered through <%= yield %> of your application layout. | |
| @@ | @@ -130,7 +130,7 @@ From your views you can use `cms_form_for` method to re-use Sofa's FormBuilder. |
| You will probably want to add a navigation link on the left side, and for that you will want to use ViewHook functionality. Create a partial that has a link to your admin area and declare in in Sofa's initializer: `ComfortableMexicanSofa::ViewHooks.add(:navigation, '/admin/navigation')`. Similarly you can add extra stylesheets, etc into admin area in the same way. | |
| - | Do you have other authentication system in place (like Devise, AuthLogic, etc) and wish to use that? For that, you will need to create a module that does the authentication check and make Comfortable Mexican Sofa use it. For example: |
| + | Do you have other authentication system in place (like Devise, AuthLogic, etc) and wish to use that? For that, you will need to create a module that does the authentication check and make ComfortableMexicanSofa use it. For example: |
| module CmsDeviseAuth | |
| def authenticate | |
| @@ | @@ -144,7 +144,7 @@ You can put this module in /config/initializers/comfortable\_mexican\_sofa.rb an |
| Working with seeds | |
| ------------------ | |
| - | Comfortable Mexican Sofa has seeds, functionality that helps manage content during development phase. It's very different from Rails seeds as Sofa's seeds are loaded with each page load. The database is completely bypassed when seeds are active. This way, you can source-control content before going live, disabling seeds and dumping everything into the database. |
| + | ComfortableMexicanSofa has seeds, functionality that helps manage content during development phase. It's very different from Rails seeds as Sofa's seeds are loaded with each page load. The database is completely bypassed when seeds are active. This way, you can source-control content before going live, disabling seeds and dumping everything into the database. |
| First, you will need to set a path where fixture files will be found (inside Sofa's initializer): | |
| @@ | @@ -164,13 +164,18 @@ There's a rake task that makes moving seeds into database (and vice-versa) easy: |
| Active Components | |
| ----------------- | |
| - | Comfortable Mexican Sofa utilizes the following: |
| + | ComfortableMexicanSofa utilizes the following: |
| * **[https://github.com/rails/rails](https://github.com/rails/rails)** - Ruby on Rails 3.*, of course | |
| * **[https://github.com/thoughtbot/paperclip](https://github.com/thoughtbot/paperclip)** - Paperclip to handle file uploads | |
| * **[https://github.com/twg/active_link_to](https://github.com/twg/active_link_to)** - Easy method to handle logic behind 'active' links | |
| - | * * * |
| + | Contributing to ComfortableMexicanSofa |
| + | -------------------------------------- |
| + | |
| + | * Fork the project |
| + | * Start a feature/bugfix branch (don't just work on the master branch) |
| + | * Commit and push until you are happy with your contribution |
|  | |