<commit_before># Contributing to typhon
Thank you for considering to contribute to the typhon project! :tada: :+1:

As a community-driven project we rely on the work and contribution of
volunteers. By participating in this project, you agree to abide by the
[code of conduct](CODE_OF_CONDUCT.md).

In order to contribute to typhon you need to be registered on
[GitHub](https://github.com/join).

## Checklist
This checklist also serves as table of contents.
1. [Fork the project](#fork-the-project)
2. [Clone your fork](#clone-the-forked-project)
3. [Set up your fork](#set-up-cloned-fork)
4. [Create a branch](#create-a-branch)
5. [Work on your contribution](#work-on-your-contribution)
6. [Pull request](#pull-request)
7. [Code review](#code-review)
8. [Follow up](#follow-up)

## Fork the project
The first step is to fork the typhon project. This is done by clicking the Fork
button on the project site.

## Clone the forked project
After forking the project you can clone the project to create a local working
copy.
```bash
$ git clone https://github.com/YOUR_USERNAME/typhon.git
```

If you want to work with SSH keys clone the project as follows:
```bash
$ git clone git@github.com:YOUR_USERNAME/typhon.git
```
You have to setup a working SSH key for your GitHub account in order to push
changes to your repository.

## Set up cloned fork
Add the URL of the original project to your local repository to be able to pull
changes from it:
```bash
$ git remote add upstream https://github.com/atmtools/typhon.git
```

Listing the remote repositories will show something like:
```bash
$ git remote -v
origin https://github.com/YOUR_USERNAME/typhon.git (fetch)<commit_msg>Removed snippet on SSH usage.<commit_after># Contributing to typhon
Thank you for considering to contribute to the typhon project! :tada: :+1:

As a community-driven project we rely on the work and contribution of
volunteers. By participating in this project, you agree to abide by the
[code of conduct](CODE_OF_CONDUCT.md).

In order to contribute to typhon you need to be registered on
[GitHub](https://github.com/join).

## Checklist
This checklist also serves as table of contents.
1. [Fork the project](#fork-the-project)
2. [Clone your fork](#clone-the-forked-project)
3. [Set up your fork](#set-up-cloned-fork)
4. [Create a branch](#create-a-branch)
5. [Work on your contribution](#work-on-your-contribution)
6. [Pull request](#pull-request)
7. [Code review](#code-review)
8. [Follow up](#follow-up)

## Fork the project
The first step is to fork the typhon project. This is done by clicking the Fork
button on the project site.

## Clone the forked project
After forking the project you can clone the project to create a local working
copy.
```bash
$ git clone https://github.com/YOUR_USERNAME/typhon.git
```

You can also connect to GitHub
[using SSH](https://help.github.com/articles/connecting-to-github-with-ssh/).

## Set up cloned fork
Add the URL of the original project to your local repository to be able to pull
changes from it:
```bash
$ git remote add upstream https://github.com/atmtools/typhon.git
```

Listing the remote repositories will show something like:
```bash
$ git remote -v
origin https://github.com/YOUR_USERNAME/typhon.git (fetch)
{'fraction_non_alphanumeric': 0.1019147621988882, 'fraction_numerical': 0.005558987029030266, 'mean_word_length': 4.517887563884157, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 9, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 1, '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': '863900', 'n_tokens_mistral': 1041, 'n_tokens_neox': 957, 'n_words': 422}