<commit_before># Contribution Guidelines

Hi and welcome to Avalon! Here are some guidelines for how you can help advance the project.

<br>

### Feature Request

If you have an idea for a new or missing feature, you can submit a GitHub issue with the following ingredients.

| # |          | Description
|--|:---------|:-
| 1 | **Goal** | In one sentence, what is the purpose of the feature?
| 2 | **Motivation** | Why does it need to exist? What made you think of it? Feel free to elaborate, the more we understand the more able we will be to figure out the best solution, or point towards an existing (but not so visible) solution.
| 3 | **Implementation** | Optional. Got an idea of how to implement it, but would like to talk about it first? This is a great place to do just that.

**Examples**

- [#385](https://github.com/getavalon/core/issues/385)
- [#390](https://github.com/getavalon/core/issues/390)
- [#415](https://github.com/getavalon/core/issues/415)

<br>

### Bug

When you run into bugs, you can submit an issue. In order for it to be resolved quickly, a bug report should contain:

| # |          | Description
|--|:---------|:-
| 1 | **Problem** | What happened? Keep it short
| 2 | **Reproducible** | How can someone else encounter the bug? Keep it minimal
| 3 | **Attempts** | What have you tried so far?
| 4 | **Solution** | Optional. If you've got an idea of what to do about it, but would like to talk about it before diving into code, here's your chance

It's hard to make an exact checklist out of these, as it depends on the particular bug. 

**Examples**

- [#389](https://github.com/getavalon/core/issues/389)
- [#377](https://github.com/getavalon/core/issues/377)
- [#412](https://github.com/getavalon/core/issues/412)

<br><commit_msg>Add note about searching and asking for a solution first.<commit_after># Contribution Guidelines

Hi and welcome to Avalon! Here are some guidelines for how you can help advance the project.

<br>

### Feature Request

If you have an idea for a new or missing feature, you can submit a GitHub issue with the following ingredients.

| # |          | Description
|--|:---------|:-
| 1 | **Goal** | In one sentence, what is the purpose of the feature?
| 2 | **Motivation** | Why does it need to exist? What made you think of it? Feel free to elaborate, the more we understand the more able we will be to figure out the best solution, or point towards an existing (but not so visible) solution.
| 3 | **Implementation** | Optional. Got an idea of how to implement it, but would like to talk about it first? This is a great place to do just that.

**But First**

1. [Search](https://github.com/getavalon/core/issues) for whether the feature you seek has already been requested and/or implemented
1. [Ask](https://gitter.im/getavalon/Lobby) whether what you seek to do can be done.

**Examples**

- [#385](https://github.com/getavalon/core/issues/385)
- [#390](https://github.com/getavalon/core/issues/390)
- [#415](https://github.com/getavalon/core/issues/415)

<br>

### Bug

When you run into bugs, you can submit an issue. In order for it to be resolved quickly, a bug report should contain:

| # |          | Description
|--|:---------|:-
| 1 | **Problem** | What happened? Keep it short
| 2 | **Reproducible** | How can someone else encounter the bug? Keep it minimal
| 3 | **Attempts** | What have you tried so far?
| 4 | **Solution** | Optional. If you've got an idea of what to do about it, but would like to talk about it before diving into code, here's your chance

It's hard to make an exact checklist out of these, as it depends on the particular bug. 

**Examples**

- [#389](https://github.com/getavalon/core/issues/389)
- [#377](https://github.com/getavalon/core/issues/377)
- [#412](https://github.com/getavalon/core/issues/412)

<br>
{'fraction_non_alphanumeric': 0.12906610703043023, 'fraction_numerical': 0.023084994753410283, 'mean_word_length': 3.588447653429603, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 14, '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': '2918858', 'n_tokens_mistral': 1213, 'n_tokens_neox': 1105, 'n_words': 507}