<commit_before># editorial-bot

This bot provides links to editorial guidance on request.

## Getting it running

Clone this repo and run `bundle install`.

[Follow the slack-ruby-bot documentation](https://github.com/slack-ruby/slack-ruby-bot/blob/master/DEPLOYMENT.md) to create and register your bot and get an API token.

Invite the bot to a channel.

You must set the SLACK_API_TOKEN environment variable to run this locally.

Once you've done this, `cd` to this folder and run `bundle exec ruby bot.rb`.

## Features

### Says hi

Say hi to the bot. It will say hi back.

### Links to Guidance

Say "rtfm", followed by a keyword. The bot will try to find guidance that matches this keyword.

### Bulleted lists

If someone in the channel tries to bring up bulleted lists, the bot will react appropriately.<commit_msg>add new features and improve dstartup docs<commit_after># editorial-bot

This bot provides editorial guidance on request. The guidance is based on the University of Bath's digital style guides.

## Getting it running

Clone this repo and run `bundle install`.

[Follow the slack-ruby-bot documentation](https://github.com/slack-ruby/slack-ruby-bot/blob/master/DEPLOYMENT.md) to create and register your bot and get an API token.

Invite the bot to a channel.

To start the bot:

1. Set the SLACK_API_TOKEN environment variable
2. `cd` to the folder where the bot is
3. Run `bundle exec ruby bot.rb`

## Features

### Says hi

Say hi to the bot.

> @editorial-bot hi

It will say hi back.

### Links to guidance

Say 'rtm', followed by a keyword.

> rtm images

The bot will try to find guidance that matches this keyword and post a link to it.

### Editorial style guide

Say 'style guide for', followed by a keyword.

> style guide for dates

The bot will check the editorial style guide for relevant guidance and post it to the channel.

### Bulleted lists

If someone in the channel tries to bring up bulleted lists, the bot will react appropriately to avert any debate.
{'fraction_non_alphanumeric': 0.0686372745490982, 'fraction_numerical': 0.001503006012024048, 'mean_word_length': 3.91871921182266, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 6, 'https://': 2, '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': '7330030', 'n_tokens_mistral': 582, 'n_tokens_neox': 558, 'n_words': 297}