https://github.com/buape/jt99-janitor

The JT-99 Janitor bot, used for various snippets to send in the network
https://github.com/buape/jt99-janitor

Last synced: about 8 hours ago
JSON representation

The JT-99 Janitor bot, used for various snippets to send in the network

• Host: GitHub
• URL: https://github.com/buape/jt99-janitor
• Owner: buape
• Created: 2022-10-04T02:37:17.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-22T19:25:22.000Z (3 months ago)
• Last Synced: 2024-08-22T21:40:29.844Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 53.7 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# JT99-Janitor

JT-99 Janitor is a utility bot for answering common questions and providing information about the JT-99 network

## Commands

`/getserverinfo` - Explains how to join other servers in the network.

`/bots` - Explains how the people chatting in the network aren't bots, and that webhooks are used to broadcast messages.

`/whatisthis` - Explains JT-99 in a nutshell.

`/support` - Directs users to the Base Station support channel.

`/basestation` - Provides an invite link to the Base Station.

`/english` - Warns users to speak in English and not any other lanauge.

`/contribute` - Directs users if they want to add a new tag

# Contributing

To contribute new tags/commands to Janitor, you will need to follow a process in your own fork of this repo.

**NOTE: It is recommended you create a new BRANCH in your fork, which is dedicated to the changes you are about to make. This way, any other commits you push to your own `master` branch won't collide with your PR, since all commits pushed to a branch will show up in your PR, even though it might be unrelated.**

## Adding a new tag file

Go to `src/commands` and duplicate an existing `.ts` file. Give it an appropriate name, and make sure to edit/replace the command names and descriptions.

## The Final Step (IMPORTANT!)

Go to `/src` and edit the `index.ts` file. Under the commands area (Line 4 and below) add `import {command-name} from "./commands/{your-command-name}`. Then, under line 39 add `new {command-name}(),`

## The FINAL Final Step

Open a pull request to the main repo, then pray. One of the developers/maintainers will review your changes, and get back to you if you are required to make any changes.