# Contribution Guidelines


## Contributing

To contribute, branch Tokenizer and file a [pull request](https://github.com/microsoft/Tokenizer/pulls).

### Building

**C# implementation**

In Tokenizer_C# folder:

```bash
dotnet build Tokenizer.sln
```

**Typescript implementation**

In tokenizer_ts folder:

```bash
npm install
npm run build
npm pack
```

### Testing

**C# implementation**

In Tokenizer_C# folder, run the tests:

```bash
dotnet test
```

**Typescript implementation**

In tokenizer_ts folder:

```bash
npm run test
```

## Coding Style

### C#

Please adhere to Microsoft's [C# Coding Conventions](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions).

### Typescript

In tokenizer_ts folder using following command for formatting and linting:

```bash
npm run format
npm run eslint
```

## Reporting Issues

If you encounter any issues, please open an [issue](https://github.com/microsoft/Tokenizer/issues).

## Contributor License Agreement

This project welcomes contributions and suggestions.  Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.