<commit_before># Contact Us

A Rails 3+ Engine providing a basic contact form.  

[![Build Status](https://secure.travis-ci.org/jdutil/contact_us.png)](http://travis-ci.org/jdutil/contact_us)

There is also a demo application showing how the ContactUs form works:

* [View Demo Form In Action](http://contact-us-demo.heroku.com)
* [View Demo Applications Source Code](http://github.com/jdutil/contact_us_demo)

## REQUIREMENTS

Contact Us requires the Formtastic Gem.  Read more about Formtastic @ https://github.com/justinfrench/formtastic

I used Formtastic as a dependency to keep things simple, and hook into your apps custom Formtastic stylesheets.
People have different tastes for their html / css markup, and I find Formtastic to be a great standardized and reusable way to build forms across apps.

If you don't want to have Formtastic as a dependency there is a fork of this project without it [here](https://github.com/sch1zo/contact_us).

## INSTALLATION

In your `Gemfile`, add the following dependencies:

    gem 'contact_us', '~> 0.1.4'

From `Rails.root` run:

    $ bundle
    $ bundle exec rake contact_us:install

In `config/initializers/contact_us.rb` modify:

    config.mailer_to = "<EMAIL>"

Change to the email address you would like to receive the form submissions at for example:

    config.mailer_to = "<EMAIL>"

## CONFIGURATION

The generator copies the view files to `app/views/contact_us`, and you can customize them to suit your needs.

You may also update your locales under `config/locales/contact_us.en.yml` or create your own.  Please feel free to submit your own locales so that other users will hopefully find this gem more useful.

## USAGE

Visit your website and navigate to `/contact_us` to see the form in action.

## INTEGRATION TESTS

Contact Us has 100% test coverage, and provides simple integration specs you can drop directly into your apps test suite if you use RSpec & Capybara.

Simply copy the `spec/integration/contact_us_lint_spec.rb` file, and add it to your integration specs. 

## ISSUES

Please report any bugs or feature requests to the Github issues page @ https://github.com/jdutil/contact_us/issues

## CONTRIBUTING

In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.

Here are some ways *you* can contribute:

* by using prerelease versions
* by reporting bugs
* by suggesting new features
* by [translating to a new language](https://github.com/jdutil/contact_us/tree/master/config/locales)
* 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](https://github.com/jdutil/contact_us/issues)
* by reviewing patches

## TODO

* Add new language translations
* Make requested configurations in branches that users can reference in their Gemfile rather than the version.  This would allow for popular requests like adding a name, subject, or both to the form while also keeping the minimalist approach in master.

Copyright (c) 2011 <NAME>, released under the [MIT license](https://github.com/jdutil/contact_us/tree/master/MIT-LICENSE).<commit_msg>Update readme todos.<commit_after># Contact Us

A Rails 3+ Engine providing a basic contact form.  

[![Build Status](https://secure.travis-ci.org/jdutil/contact_us.png)](http://travis-ci.org/jdutil/contact_us)

There is also a demo application showing how the ContactUs form works:

* [View Demo Form In Action](http://contact-us-demo.heroku.com)
* [View Demo Applications Source Code](http://github.com/jdutil/contact_us_demo)

## REQUIREMENTS

Contact Us requires the Formtastic Gem.  Read more about Formtastic @ https://github.com/justinfrench/formtastic

I used Formtastic as a dependency to keep things simple, and hook into your apps custom Formtastic stylesheets.
People have different tastes for their html / css markup, and I find Formtastic to be a great standardized and reusable way to build forms across apps.

If you don't want to have Formtastic as a dependency there is a fork of this project without it [here](https://github.com/sch1zo/contact_us).

## INSTALLATION

In your `Gemfile`, add the following dependencies:

    gem 'contact_us', '~> 0.1.4'

From `Rails.root` run:

    $ bundle
    $ bundle exec rake contact_us:install

In `config/initializers/contact_us.rb` modify:

    config.mailer_to = "<EMAIL>"

Change to the email address you would like to receive the form submissions at for example:

    config.mailer_to = "<EMAIL>"

## CONFIGURATION

The generator copies the view files to `app/views/contact_us`, and you can customize them to suit your needs.

You may also update your locales under `config/locales/contact_us.en.yml` or create your own.  Please feel free to submit your own locales so that other users will hopefully find this gem more useful.

## USAGE

Visit your website and navigate to `/contact_us` to see the form in action.

## INTEGRATION TESTS

Contact Us has 100% test coverage, and provides simple integration specs you can drop directly into your apps test suite if you use RSpec & Capybara.

Simply copy the `spec/integration/contact_us_lint_spec.rb` file, and add it to your integration specs. 

## ISSUES

Please report any bugs or feature requests to the Github issues page @ https://github.com/jdutil/contact_us/issues

## CONTRIBUTING

In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.

Here are some ways *you* can contribute:

* by using prerelease versions
* by reporting bugs
* by suggesting new features
* by [translating to a new language](https://github.com/jdutil/contact_us/tree/master/config/locales)
* 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](https://github.com/jdutil/contact_us/issues)
* by reviewing patches

## TODO

* Add new language translations
* Make requested configurations in branches, and document how to reference within your Gemfile rather than the version.  Configurations todo: with name, with subject, with name & subject

Copyright (c) 2011 <NAME>, released under the [MIT license](https://github.com/jdutil/contact_us/tree/master/MIT-LICENSE).
{'fraction_non_alphanumeric': 0.08244392884764115, 'fraction_numerical': 0.0037122969837587007, 'mean_word_length': 4.4889643463497455, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 11, 'https://': 14, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1930928', 'n_tokens_mistral': 1872, 'n_tokens_neox': 1797, 'n_words': 779}