<commit_before># Contributing

([back to README](../README.md))

If you find any problems or have any ideas for improvements, please do not hesitate to [open an issue](https://github.com/raxod502/radian/issues/new), or—even better—[a pull request](https://github.com/raxod502/radian/compare).

However, without attention to quality, all code becomes unmaintainable. This is especially true for dotfiles, so please try to follow the guidelines in this document when contributing code to this repository. I won't reject contributions just because of a missing period, but it is polite to put in some effort to make it easier for future contributors to maintain your code.

If you don't have any problems, but still want to help out, check out [the currently open issues](https://github.com/raxod502/radian/issues)—I can use all the help I can get!

## Documentation

> Every line or logical grouping of lines of code in every dotfile **must** have an explanatory comment.

[![Documentation cartoon](http://www.datamation.com/img/2009/12/documentation-please.jpg)](http://www.datamation.com/cnews/article.php/3852701/Tech-Comics-Software-Documentation.htm)

At the very minimum, you must explain what the code is supposed to be doing. This way, people making later modifications can make sure they are not breaking its original functionality.

```
# Open new panes in the same directory as the current pane.
bind % split-window -h -c "#{pane_current_path}"
bind '"' split-window -v -c "#{pane_current_path}"
```

If the line modifies some default setting, you should also make note of what the default was. This makes it easier to tell what will happen if the line is removed.

```<commit_msg>Add table of contents to CONTRIBUTING.md<commit_after># Contributing

([back to README](../README.md))

If you find any problems or have any ideas for improvements, please do not hesitate to [open an issue](https://github.com/raxod502/radian/issues/new), or—even better—[a pull request](https://github.com/raxod502/radian/compare).

However, without attention to quality, all code becomes unmaintainable. This is especially true for dotfiles, so please try to follow the guidelines in this document when contributing code to this repository. I won't reject contributions just because of a missing period, but it is polite to put in some effort to make it easier for future contributors to maintain your code.

If you don't have any problems, but still want to help out, check out [the currently open issues](https://github.com/raxod502/radian/issues)—I can use all the help I can get!

## Table of contents

<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again -->


- [Contributing](#contributing)
    - [Table of contents](#table-of-contents)
    - [Documentation](#documentation)
    - [Commit history](#commit-history)
        - [Commit messages](#commit-messages)
        - [Commit history](#commit-history)
    - [Code style](#code-style)

<!-- markdown-toc end -->

## Documentation

> Every line or logical grouping of lines of code in every dotfile **must** have an explanatory comment.

[![Documentation cartoon](http://www.datamation.com/img/2009/12/documentation-please.jpg)](http://www.datamation.com/cnews/article.php/3852701/Tech-Comics-Software-Documentation.htm)

At the very minimum, you must explain what the code is supposed to be doing. This way, people making later modifications can make sure they are not breaking its original functionality.

```
# Open new panes in the same directory as the current pane.
bind % split-window -h -c "#{pane_current_path}"
bind '"' split-window -v -c "#{pane_current_path}"
```

If the line modifies some default setting, you should also make note of what the default was. This makes it easier to tell what will happen if the line is removed.

```
{'fraction_non_alphanumeric': 0.09551148225469729, 'fraction_numerical': 0.011482254697286013, 'mean_word_length': 4.398591549295775, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 7, 'https://': 6, 'lorem ipsum': 0, 'www.': 4, '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': '3896929', 'n_tokens_mistral': 1103, 'n_tokens_neox': 1020, 'n_words': 469}