<commit_before># Developing

## Testing

Testing is done with [Minitest](https://github.com/seattlerb/minitest/) using the spec syntax and
[Minifacture](https://github.com/stephencelis/minifacture) for factories. It's supposed to be as
minimal and readable as possible. You can see a full history of tests [here](https://travis-ci.org/alcesleo/keymail/builds).

### Running the tests

To run all the tests:

    rake test

### Code coverage

Is generated automatically every time the tests are run, to open the statistics run:

    rake coverage

## Documentation

I'm generating this documentation using [MkDocs](https://github.com/tomchristie/mkdocs).

To work on the documentation locally you first need to install it:

    pip install mkdocs

Then you can serve the website locally using:

    mkdocs serve

Just keep the `mkdocs.yml` in sync and you should be all set.<commit_msg>Release instructions<commit_after># Developing

## Testing

Testing is done with [Minitest](https://github.com/seattlerb/minitest/) using the spec syntax and
[Minifacture](https://github.com/stephencelis/minifacture) for factories. It's supposed to be as
minimal and readable as possible. You can see a full history of tests [here](https://travis-ci.org/alcesleo/keymail/builds).

### Running the tests

To run all the tests:

    rake test

### Code coverage

Is generated automatically every time the tests are run, to open the statistics run:

    rake coverage

## Documentation

I'm generating this documentation using [MkDocs](https://github.com/tomchristie/mkdocs).

To work on the documentation locally you first need to install it:

    pip install mkdocs

Then you can serve the website locally using:

    mkdocs serve

Just keep the `mkdocs.yml` in sync and you should be all set.

## Releases

Versioning follows [SemVer](http://semver.org/), except prereleases are
indicated with a dot, because of RubyGems.(e.g `v0.1.0.pre`)

### Checklist

- Make sure the tests pass
- Make sure your working directory is clean
- Bump the version in `lib/keymail/version.rb` and commit it
- `rake release`
{'fraction_non_alphanumeric': 0.0861656294877932, 'fraction_numerical': 0.0014360938247965534, 'mean_word_length': 4.147783251231527, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4510580', 'n_tokens_mistral': 631, 'n_tokens_neox': 600, 'n_words': 252}