<commit_before># Welcome to the contributing guide for Voca!

We love contributions from everyone. Thanks for your time and the will to improve Voca.
   
Please note we have a [code of conduct](CONTRIBUTING), please follow it in all your interactions with the project.

### Reporting an issue or suggest a feature

The GitHub issue tracker is the preferred channel for bug reports, change requests and submitting pull
requests.

Make sure to **search for existing issues**. Please check to see if someone
has already reported your problem or requested your idea.  
The bug report must provide at least the following information:

* The expected behavior: how in your opinion the code should behave
* The actual behavior: how the code actually works
* Steps to reproduce: a step by step scenario how to reproduce the problem
* Technical details: useful details like Browser type and version, Operating system, NodeJS version

If you decided to suggest a new feature, please provide detailed description what value it brings and possible use cases. 


### Creating pull requests
Pull requests are great.  
When contributing to this repository, please first discuss the change you wish to make via issue, email to [<EMAIL>](email), 
or any other method with the owners of this repository before making a change.

When submitting the request please be sure:

* The pull request passes the CI build
* The modification is accompanied with unit tests
* The necessary updates to documentation are made

# Technical details

Voca codebase stands on the principles of modularity, small specialized functions and meaningful naming. 
Testing is an inseparable part of the library, so every function must be tested in details and have almost 100% code coverage.  


Voca development environment requires Node version 4 and above.  

Fork the repository, then clone it into your project directory.    

Install the development dependencies within Voca source directory:
```bash
npm install
```

1) Build the bundle into `dist/` folder.  
`dist/voca.js` is an [UMD](https://github.com/umdjs/umd) build compatible with CommonJS, RequireJS and Browser globals.  
`dist/voca.min.js` is the minified UMD, production-ready.

```bash
npm run build
```

2) Run the library over the unit tests:
```bash
npm test
```

3) Verify the code coverage:
```bash
npm run coverage
```

4) Check the code using eslint tool:
```bash
npm run eslint
```

[CONTRIBUTING]: https://github.com/panzerdp/voca/blob/master/.github/CONTRIBUTING.md
[email]: mailto:<EMAIL><commit_msg>Contributing updates<commit_after># Welcome to the contributing guide for Voca!

We love contributions from everyone. Thanks for your time and the will to improve Voca.
   
Please note we have a [code of conduct](CONTRIBUTING), please follow it in all your interactions with the project.

### Reporting an issue or suggest a feature

The GitHub issue tracker is the preferred channel for bug reports, change requests and submitting pull
requests.

Make sure to **search for existing issues**. Please check to see if someone has already reported your problem or requested your idea.  

The bug report must provide at least the following information:

* The expected behavior: how in your opinion the code should behave
* The actual behavior: how the code actually works
* Steps to reproduce: a step by step scenario how to reproduce the problem
* Technical details: useful info like Browser type and version, Operating system, NodeJS version and other

If you decided to suggest a new feature, please provide detailed description what value it brings and possible use cases. 

### Creating pull requests
Pull requests are great.  
When contributing to this repository, please first discuss the change you wish to make via issue, email to [<EMAIL>](email), 
or any other method with the owners of this repository before making a change.

When submitting the request please be sure:

* The pull request to pass the CI build
* The modification to be accompanied with unit tests
* The necessary updates to documentation are made

# Technical details

Voca codebase stands on the principles of modularity, small specialized functions and meaningful naming. 
Testing is an inseparable part of the library, so every function must be tested in details and have almost 100% code coverage.  

### Development requirements

Voca development environment requires Node **version 4** and above.  

### Configuring dev environment

Fork the repository, then clone it into your project directory.    

Install the development dependencies within Voca source directory:
```bash
npm install
```

### Building

Build the bundle into `dist/` folder.  
`dist/voca.js` is an [UMD](https://github.com/umdjs/umd) build compatible with CommonJS, RequireJS and Browser globals.  
`dist/voca.min.js` is the minified UMD, production-ready.

```bash
npm run build
```

### Testing 

Run the library over the unit tests:
```bash
npm test
```

Verify the code coverage:
```bash
npm run coverage
```

### Linting
Check the code using eslint tool:
```bash
npm run eslint
```

[CONTRIBUTING]: https://github.com/panzerdp/voca/blob/master/.github/CONTRIBUTING.md
[email]: mailto:<EMAIL>
{'fraction_non_alphanumeric': 0.06110254433307633, 'fraction_numerical': 0.002313030069390902, 'mean_word_length': 4.526091586794462, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2228926', 'n_tokens_mistral': 1352, 'n_tokens_neox': 1261, 'n_words': 732}