Skip to content

Latest commit

 

History

History
72 lines (58 loc) · 2.98 KB

README.md

File metadata and controls

72 lines (58 loc) · 2.98 KB
Raw

SeeClickFix API

A Ruby wrapper for the SeeClickFix APIs at http://help.seeclickfix.com/kb/api/api-overview

Does your project or organization use this gem?

Add it to the apps wiki!

Installation

$ gem install seeclickfix

Documentation

http://rdoc.info/gems/seeclickfix

Continuous Integration

Build Status

Usage Examples

require 'seeclickfix'

@client = SeeClickFix::Client::New
a = @client.list_issues("San Francisco")
a.first.issue_id # => 108657

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

  • by using alpha, beta, and prerelease versions
  • by reporting bugs
  • by suggesting new features
  • by writing or editing documentation
  • by writing specifications
  • by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
  • by refactoring code
  • by resolving issues
  • by reviewing patches

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issuse by voting it up. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

  1. Fork the project.
  2. Create a topic branch.
  3. Implement your feature or bug fix.
  4. Add documentation for your feature or bug fix.
  5. Run bundle exec rake doc:yard. If your changes are not 100% documented, go back to step 4.
  6. Add specs for your feature or bug fix.
  7. Run bundle exec rake spec. If your changes are not 100% covered, go back to step 6.
  8. Commit and push your changes.
  9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)

Copyright

Copyright (c) 2010 Code for America Laboratories See LICENSE for details.

Code for America Tracker