<commit_before>---
layout: page
title: Contributing
---

By all means.

h3. Relevant Links

* "Google Group":http://groups.google.com/group/vanity-talk
* "Source code":http://github.com/assaf/vanity
* "Continuous integration":http://runcoderun.com/assaf/vanity
* "Code metrics":http://devver.net/caliper/project?repo=git%3A%2F%2Fgithub.com%2Fassaf%2Fvanity.git


h3. Building From Source

Vanity test suite requires "Rails":http://rubyonrails.org, "Mocha":http://mocha.rubyforge.org/, "Timecop":http://github.com/jtrupiano/timecop and "SQLite3":http://rubyforge.org/projects/sqlite-ruby/.  To run the test suite:

<pre>
$ gem install rails mocha timecop sqlite3-ruby
$ rake
</pre>

To clean up after yourself:

<pre>
$ rake clobber
</pre>

To package Vanity as a gem and install on your machine:

<pre>
$ rake install
</pre>
<commit_msg>Contributing page links to open issues page.<commit_after>---
layout: page
title: Contributing
---

By all means.

h3. Relevant Links

* "Google Group":http://groups.google.com/group/vanity-talk
* "Source code":http://github.com/assaf/vanity
* "Continuous integration":http://runcoderun.com/assaf/vanity
* "Code metrics":http://devver.net/caliper/project?repo=git%3A%2F%2Fgithub.com%2Fassaf%2Fvanity.git
* "Open Issues":http://github.com/assaf/vanity/issues


h3. Building From Source

Vanity test suite requires "Rails":http://rubyonrails.org, "Mocha":http://mocha.rubyforge.org/, "Timecop":http://github.com/jtrupiano/timecop and "SQLite3":http://rubyforge.org/projects/sqlite-ruby/.  To run the test suite:

<pre>
$ gem install rails mocha timecop sqlite3-ruby
$ rake
</pre>

To clean up after yourself:

<pre>
$ rake clobber
</pre>

To package Vanity as a gem and install on your machine:

<pre>
$ rake install
</pre>

{'fraction_non_alphanumeric': 0.1512222853894258, 'fraction_numerical': 0.01023308698123934, 'mean_word_length': 4.587301587301587, 'pattern_counts': {'":': 17, '<': 15, '<?xml version=': 0, '>': 15, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, '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': '5290574', 'n_tokens_mistral': 665, 'n_tokens_neox': 635, 'n_words': 148}