Skip to content

"Read The Bin": a bot made to push long code snippets to our custom-made bin

License

Notifications You must be signed in to change notification settings

readthedocs-fr/bin-client-discord

Repository files navigation

Read The Bin

A simple discord bot, made for Read the Docs, to automatically replace long code blocks with snippets using rtd-bin.

Contribution

After forking, do these commands:

git clone https://github.com/<your_username>/bin-client-discord
cd bin-client-discord

# we recommend you add this repo as an upstream remote
git remote add upstream https://github.com/readthedocs-fr/bin-client-discord

yarn install

We use Conventional Commits for commits messages.

git checkout -b <branch_name>
# make somes changes

yarn lint # or lint-fix
yarn format
yarn test

git add .
git commit -m "conventional commit"
git push origin <branch_name>

Environment vars

# From how many lines the bot should transform messages
MAX_LINES=20
# Bin URL with "/new" path
CREATE_BIN_URL=http://127.0.0.1:8012/new
# Your bot's token
DISCORD_TOKEN=
# Discord categories' ID, comma-separated
CATEGORIES=
# ms
REQUEST_TIMEOUT=5000

About

"Read The Bin": a bot made to push long code snippets to our custom-made bin

Topics

Resources

License

Stars

Watchers

Forks

Languages