Git Product home page Git Product logo

gitord's Introduction

Gitord npm version

Description

Gitord is a free and open-source "bot template" that alerts you in the Discord Chanel of your choice if your github repository does not respect the rules you apply to it.

Installation

Check Gitord's wiki

npm i gitord

Usage

import { Gitord } from "./Gitord";
var bot = new Gitord(
  "Discord token",
  "Github token",
  "test-kanban-bot",
  "repo_test",
  "Discord chanel ID"
);
bot.welcome_message = false;
bot.RefreshTime = 5;
bot.Rules.IssueMinimalBody = 1;
bot.Rules.PullNeedToFix = false;
bot.Start();
  • 'Discord_token'
  • 'Github_token' by leaving "anon" as a parameter of Github_token you can use Gitord anonymously, only for public directories and with an API rate limit
  • 'Github_Repo_owner'
  • 'Github_Repo_name'

example: "QuentinGruber" is the repo_owner of this repo and "Gitord" is the repo_name*

  • 'Chanel_id'

To get the ID of a channel you have to switch your Discord to developer mode.

  1. Go to the "appearance" settings of your account
  2. Enable developer mode
  3. Right-click on the channel of your choice and copy its identifier
  • 'User_list'

    example : "User_list":[["Github_Username1","DiscordID1"],["Github_Username2","DiscordID2"]]

    To get a DiscordID right-click on the user of your choice and copy its identifier

More info about the available rules here.

Used Node.js version 12.18.0

gitord's People

Contributors

quentingruber avatar

Watchers

 avatar  avatar

gitord's Issues

Make a "rule" file

a configuration file to easily modify the rules that the Kanban Bot is trying to apply.

  • Issue need to have a label?

  • Issue need at least one assignee

  • Issue need to have at least a small description

  • Pull request need to fix at least one issue

  • Pull request need to have at least one assignee if there is a WIP

  • Pull request need to have at least one reviewer if not in WIP

Unexpected end of JSON input

For the moment the error is just handled but not fixed be7ee1f

low priority bug: the problem occurred 1 time for more than 100 successful queries

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.