Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 2.08 KB

Contributing

The issue tracker can be used to report bugs, make feature suggestions, or browse to see the open issues that are yet to be addressed.

If you wish to contribute to Professor Kauri's development, first open an issue to discuss your idea or perceived bug. If the consensus is that the feature/fix is needed, you can fork the repository and submit a pull request. Contributing to Kauri will require knowledge of TypeScript 3.8, discord.js v12, discord-akairo v8 and possibly Mongoose.

Setting up your local copy

  1. Fork & clone the repository to your computer
  2. Run npm install to download and install all additional packages
  3. Run npm install -g typescript to install the TypeScript compiler globally

Running and testing your local copy

  1. Run npm run build to compile the TypeScript and create the dist directory, or npm run watch to monitor for changes and auto-build.
  2. Create a dist/.env file with the following contents:
    NODE_ENV: development
    KAURI_TOKEN: Generated from the Discord Developer Portal
    KAURIDB_URI: Available from Monbrey upon request
  3. Run the bot: node ./dist/index.js
  4. Add your bot to a test server - instructions are available on the Discord.js Guide

Developing and submitting changes

  1. Create a new branch in your repository for the feature/fixes
  2. Commit changes to this branch and test
  3. Open a Pull Request to merge changes from your repository into the original.
  4. Include a description of the changes your PR makes and why it should be merged. If your PR addresses an open issue, you can reference it in the description as Closes #5 or fixes #12 to automatically link and close issues.
  5. Changes will be reviewed and merged as appropriate.