Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 2.74 KB

README.md

File metadata and controls

76 lines (56 loc) · 2.74 KB
Raw

Chatreach

An open source tool built in Ruby on Rails for social service agencies to provide text message based content and locator services for their clients.

Chatreach

Getting Started Guide

http://chatreachwiki.pbworks.com/

Development Installation

We recommend using Ruby Version Manager.

git clone [email protected]:danmelton/chatreach.git
cd chatreach
bundle install
rake db:migrate

To get Seed Data:

rake db:reset
or
rake db:seed

Status

This application is going through a heavy re-write. You can see progress here roadmap

Credits

This application was built with the support of Advocates for Youth and New Morning Foundation in 2008. The code is offered as BSD

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.)