jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 07:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ab15583f2d17ae129d4e2cffafbb2aad33b42974
OpenBB/discordbot/CONTRIBUTING.md
DidierRLopes a017f7003a Improve general discord documentation (#821) 
* improve general discord documentation

* remove unused images

* Update README.md

* Update CONTRIBUTING.md

Co-authored-by: Didier Lopes <didierlopes@didiers-mbp.home>
2021-10-18 23:03:27 +01:00

978 B
Vendored
Raw Blame History

Code Structure and Contributing

UNDER DEVELOPMENT!

The file system is built in the following way:

  • Each command is one file with the essential functions for the command and is named COMMANDNAME.py.
  • Each context is a directory and has a menu file named CONTEXT_menu.py.
  • The menu file works by controlling every command in the context and it contains the menu command.
  • discordbot.py can loads every menu file from each context.
  • The settings shall be in the config_discordbot.py file (example: API keys).

If a function is often used by multiple files then add them to the helpers.py file. Please try to use the _view files from the GST to get the data for the commands if possible.

Feel free to contribute to the discord bot, add more contexts, commands or just do other improvements. To see the current prioritize of the development see the TODO list in the discord bot project (https://github.com/GamestonkTerminal/GamestonkTerminal/projects/4).