<commit_before>![Ninbot Logo](docs/images/ninbot-github-social.png)
# Ninbot ![Master Branch Build](https://github.com/Nincodedo/Ninbot/workflows/Master%20Build/Deploy/badge.svg?branch=master) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=com.nincraft%3Aninbot&metric=alert_status)](https://sonarcloud.io/dashboard?id=com.nincraft%3Aninbot)
Ninbot is a Discord bot with various silly commands and actions, such as dabbing. Ninbot is built for OCW Discord using [JDA.](https://github.com/DV8FromTheWorld/JDA) [Click here](https://discordapp.com/oauth2/authorize?client_id=204484879554052096&scope=bot&permissions=285600848) to add Ninbot to your server!

[Check the documentation for a list of features and help with commands.](http://ninbot.nincodedo.com/)<commit_msg>Add development goals<commit_after>![Ninbot Logo](docs/images/ninbot-github-social.png)
# Ninbot ![Master Branch Build](https://github.com/Nincodedo/Ninbot/workflows/Master%20Build/Deploy/badge.svg?branch=master) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=com.nincraft%3Aninbot&metric=alert_status)](https://sonarcloud.io/dashboard?id=com.nincraft%3Aninbot)
Ninbot is a Discord bot with various silly commands and actions, such as dabbing. Ninbot is built for OCW Discord using [JDA.](https://github.com/DV8FromTheWorld/JDA) [Click here](https://discordapp.com/oauth2/authorize?client_id=204484879554052096&scope=bot&permissions=285600848) to add Ninbot to your server!

[Check the documentation for a list of features and help with commands.](http://ninbot.nincodedo.com/)

## Development Goals

### Use the Reaction Framework

Prioritize the reaction framework when possible. Adding a target phrase and a response to the [responses.json](src/main/resources/responses.json) is sometimes all you need to do. Responses done through this will react with emojis automatically if its possible. This also helps with the next development goal...

### Minimum Chat Clutter

Prioritize reacting with emojis when possible. Sending chat messages should only be done if absolutely neccessary (comedy is sometimes neccessary). Commonly used Emojis for Ninbot can be found in the [common Emojis class](src/main/java/com/nincraft/ninbot/components/common/Emojis.java).

|  Action|Emoji  |
|--------|-------|
|Success |✅     |
|Failure |❌     |
|Unknown |❔      |

### Documentation should be up to date

Changes and additions to a command or action that would affect the end user should be documented. The latest version of Ninbot is the only supported version, so the documentation needs to be up to date.
{'fraction_non_alphanumeric': 0.11014052411697683, 'fraction_numerical': 0.025066464109380935, 'mean_word_length': 5.51980198019802, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, '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': '2158876', 'n_tokens_mistral': 861, 'n_tokens_neox': 819, 'n_words': 237}