<commit_before><commit_msg>Started working on a CONTRIBUTING file<commit_after># Contributing to Imbo
## Running tests

Imbo has both [Behat](http://docs.behat.org/en/v2.5/) and [PHPUnit](https://phpunit.de/) tests, and when adding new features or fixing bugs you are required to add relevant test cases.

### Behat

```
./vendor/bin/behat --strict --profile no-cc --config tests/behat/behat.yml
```

The `--profile no-cc` arguments will disable the generation of code coverage. If you skip these arguments you will get code covarage of the Behat tests.

### PHPUnit

```
./vendor/bin/phpunit --verbose -c tests/phpunit
```

Include `--coverage-html <path>` if you want to generate code coverage report of the tests.

## Writing documentation

Imbo uses [Read the docs](https://readthedocs.org/projects/imbo/) for documentation, and all docs are located in the `docs` dir. The docs are written using Sphinx, and if you are contributing new features please add relevant docs.
{'fraction_non_alphanumeric': 0.10985626283367557, 'fraction_numerical': 0.002053388090349076, 'mean_word_length': 4.158730158730159, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 2, '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': '2704839', 'n_tokens_mistral': 293, 'n_tokens_neox': 281, 'n_words': 120}