Tutorial: How to Contribute

How to Contribute

Welcome

Thank you for visiting this page on how to contribute to this project!

Table of contents

Reporting bugs
Suggesting Enhancements
Code of Conduct
Styleguides
Sources

Links to resources

Styleguides

  • Limit the first line to 72 characters or less

Reporting bugs

These are the following steps for reporting a bug:

  • Check the current list of bugs to see if it is already reported.
  • Determine exactly how to cause the bug and verify it is reproducible.
  • Current Bug List
    Fill out this google form: https://docs.google.com/forms/d/e/1FAIpQLScx8jQOhSAXE9-7SDUehAhvrApX6_j2DFTUnyr5c4HlGUGPrA/viewform?usp=sf_link

Pull Requests

  • Follow the Styleguides
  • Engage the community in working towards the best possible Mental Health Discord Bot

Suggesting enhancements

Check the current list of suggested enhancements

Code of conduct

This project is goverend by the Code of Conduct

Sources:

Used parts of https://github.com/atom/atom/blob/master/CONTRIBUTING.md

Bug List:

  • upgrade music command such that the bot can play,pause,stop and resume the music in a voice channel
  • figure out testing with MockDiscord
  • add more data for diet_recs.csv
  • add more data for exercise.csv
  • add more data for support_animals.csv

Enhancements

  • Set up SQL DB for dynamic data access/storage
  • Gamification of new/existing commands (Add a gamifying feature to the bot such as (growing a plant and tending to it)
  • anonymous command: Talk to another person in another discord via the bot anonymously
  • break command: Take a break command (Activate to periodically ping user to take a break.)
  • survey command:well being survey (daily mood tracker, etc...)
  • venting command: where usesrs can vent anonymously to a channel
  • breathing command: where users can practice deep breathing for 1 or 2 minutes by following an animated gif or video displayed in the embed
  • reminders command: users can set a reminder for whatever they may need (self care, medication, etc...)
  • meditation command: assists users in a small meditation cycle
  • yoga command: shows different positions users can do
  • anything else that is mental health related!