Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Comments plugin for the Rails 3-based Governor blogging system.
Ruby JavaScript
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
app
config/locales
lib
script
spec
tmp
.document
.gitignore
.rspec
Gemfile
Gemfile.lock
LICENSE.txt
README.rdoc
Rakefile
VERSION
governor_comments.gemspec

README.rdoc

governor_comments

Governor (named after Rod Blagojevich) is the pluggable blogging platform for Rails, built for people who want to build their blog into their website, not build their website into their blog.

governor_comments is a plugin for Governor, allowing users and guests to comment on your blog.

Dependencies

  • Governor, version 0.2.2 or higher. In addition, it requires that your User class (or whatever classes can be associated with an article) have name, email, and website fields.

  • ActiveRecord

  • Optional: Rakismet to integrate Akismet spam filtering.

Setting Up

In your Gemfile, add the following:

gem 'governor'
gem 'governor_comments'

Once you've installed the gem into your app, you need to run the generator:

rails generate governor:create_comments [RESOURCE]

If you've only created one type of resource (which is typical), then you won't need any arguments. Otherwise, you'll need to specify which model you want to add comments to. This will create a Comment class and associated migration. If you've created multiple resource types and you'd like to use comments with multiple types, then specify --polymorphic as an option.

Make sure to add the name, email, and website fields to your User model if they don't exist already.

Usage

Now, when you browse to an article, you'll see places to add comments right in the page. You really don't have to do anything special at this point.

Contributing to governor_comments

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it

  • Fork the project

  • Start a feature/bugfix branch

  • Commit and push until you are happy with your contribution

  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.

  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright © 2011 Liam Morley. See LICENSE.txt for further details.

Something went wrong with that request. Please try again.