search

every-Bot / everyBot

A discordpy bot for all purposes
GNU Lesser General Public License v3.0
4 stars 3 forks source link

Setup process for public development #12

Closed simbarb closed 3 years ago

simbarb commented 3 years ago

Hello,

I am looking to set a local dev copy of the bot but it seems the setup information in the readme is outdated (no reference to MongoDB for example).

Any chance for the readme file to be updated?

Cheers!

Givo29 commented 3 years ago

Hey! Awesome to see that you're interested in the bot!

The README is in fact outdated, it was written before the database was added at all... I think this is mostly because I haven't properly thought through the processes of having other people helping with development/developing their own modules (which is the end goal - for modules to be community driven and developed by others).

Obviously I can't give people access to the official databases so it will all have to be setup locally, maybe a "test docker instance" of sorts like you mentioned in #11 would be a good idea for developers to spin up a bot with a local database and develop their modules on.

If you have any ideas or thoughts let me know, I'm open to any and all suggestions as to how this should work.

JBrummans commented 3 years ago

A contributing guide may be worth writting as part of this too.

Givo29 commented 3 years ago

I don't think the 'vision' intended for the bot has ever been officially written. I think what I'll do is add a vision statement into the README and setup a docker instance for developers to make use of and add setup for that in a contributing guide of some sort.

Contributing for this bot for the most part won't be contributing in the traditional sense, it will be developing modules for everyone who uses the bot to be able to use.

simbarb commented 3 years ago

Okay. Once the vision is written and a local development workflow is available I am happy to contribute.

I can assist on the Docker side of things if you want a hand.

Givo29 commented 3 years ago

Closing this as docker has been setup with a local db instance and a setup guide for contributing has been outlined in the README.