Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

39 lines (27 loc) · 1.21 KB
Raw

Contributing to Yappy GitLab

Clone repo

$ git clone https://github.com/YappyBots/YappyGitlab.git

Linting

Please use an ESLint plugin for your editor, and use the current configuration (located in .eslintrc).

GitLab Events

The different GitLab events each have their own name, followed by " Hook".

An event may have an action. For example, the event can be an issue event, and the action may be open. The file that will be read for the styling of the event is EVENT-ACTION.js, everything being lowercase. If the event has a space in its actual name, like "Tag Push Hook", the corresponding file would be called tag_push.js, replacing the space with _.

Starting the bot

Yappy GitLab needs the following environment variables:

The following settings are required:

  • DISCORD_TOKEN
  • DB_URL
  • DISCORD_CLIENT_ID (for the web dashboard)
  • DISCORD_CLIENT_SECRET (for the web dashboard)

Yappy GitLab also needs to be run with NodeJS v8 or higher. A few examples on running the bot:

$ node lib/index.js
$ npm start
$ nodemon # if