Skip to content

Knuth-Programming-Hub/KLE-bot

Repository files navigation

KLE Discord Bot

KLE is a chat bot for the Knuth Programming Hub (KPH) Discord server. The purpose of this bot is to automate various tasks of the Hub and at the same time improve the Competitve Programming culture in the college.

Features

  • Providing links related to KPH's online presence
  • Managing Meetups/Events
  • Identifying and Verifying JIIT students
  • Year-wise ranklists for the Discord server
  • Standings for Codeforces contests (KPH's Codeforces group contests included)
  • Sending invite to join KPH Codeforces group
  • Creating GitHub gist for a particular code
  • Granting "Member" role on reacting to a particular message
  • Custom command prefix
  • Clearing recent messages in a channel

Future Prospects

  • Automating tasks related to KPH's Codeforces group
  • Commands related to Codeforces handles
  • Generating data for members' performances in Codeforces contests
  • Connecting to the Telegram group
  • Managing Polls

How to Get Started

  • Follow the steps provided here.
  • If you don't want to go through the hassle of setting up the bot, join our server to try the bot instantly.

Contributing workflow

Note: Do checkout our Project board. Here you will find the things we already are working on and have planned for improving the bot. Also checkout the Discussions for this repository.

  • You can work on existing issues or create new issues and work on them.
  • After completing the steps mentioned in CONTRIBUTING.md you have the project up and running. You are right now in master branch. (You can check your current branch with git branch.)
  • Create a new branch with $ git checkout -b <new branch name>. You can switch branches with git checkout <branch name>.
  • Make changes. You can use git status to check the state of you working directory.
  • Add all the files to staging area using git add ..
  • Commit the changes git commit -m <commit message>. (Make sure to write relevant commit messages!)
  • Push the changes git push origin <branch name>.
  • Make a pull request.
  • After code review, your PR may or may not be merged depending on your changes.

Opening an Issue

Open an issue here to...

Request support

If you have a question about this project, how to use it, or just need clarification about something:

  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. If not, please be ready to provide that information if the maintainers ask for it.

Report an Error or Bug

If you run into an error or bug with the project:

  • Include reproduction steps that someone else can follow to recreate the bug or error on their own.
  • Provide project and platform versions (nodejs, npm, etc) depending on what seems relevant. If not, please be ready to provide that information if maintainers ask for it.

Request a Feature

If the project doesn't do something you need/want it to do or you have a new feature in mind:

  • Provide as much context as you can about what you're running into.
  • Please try and be clear about why existing features and alternatives would not work for you.

Usage

  • Use !help to get the list of available commands.
  • To get more details about a specific command you can use !help <command-name>.
  • In order to run admin-only commands, you need to have the Admin role, which needs to be created in your Discord server and assign it to yourself/other administrators.

License

MIT

About

A bot designed for the Knuth Programming Hub Discord server.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published