Description
Add more information on how to run or reload a bot during testing to the contributing guides.
Reason
For people who are new to using Docker / discord.py / contributing to python-discord/bot or python-discord/sir-lancebot, this will be a helpful resource on how to test small changes during the development stage (or review).
Proposed Implementation
Based on a short discussion in #dev-contrib [message link], this is a short and possibly incomplete overview of how to start / reload a bot:
- Stop and Start Docker from the desktop application or from the command line
docker start -d snekbox redis postgres web , docker-compose up , etc (not recommended)
- With poetry:
poetry run task start from the root, if outside the venv or task start if inside the venv
py -m <bot/sir-lancebot> from the root, inside the venv
- Set up a run task (automatically run
py -m <bot/sir-lancebot>)
- If changing a cog, reload cog from the discord channel with
!c r <cog> or .c r <cog>
This summary can be a new section in the pages here:
sir-lancebot contributing guide
pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md
or here:
bot contributing guide
pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md
Description
Add more information on how to run or reload a bot during testing to the contributing guides.
Reason
For people who are new to using Docker / discord.py / contributing to python-discord/bot or python-discord/sir-lancebot, this will be a helpful resource on how to test small changes during the development stage (or review).
Proposed Implementation
Based on a short discussion in #dev-contrib [message link], this is a short and possibly incomplete overview of how to start / reload a bot:
docker start -d snekbox redis postgres web,docker-compose up, etc (not recommended)poetry run task startfrom the root, if outside the venv ortask startif inside the venvpy -m <bot/sir-lancebot>from the root, inside the venvpy -m <bot/sir-lancebot>)!c r <cog>or.c r <cog>This summary can be a new section in the pages here:
sir-lancebot contributing guide
pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md
or here:
bot contributing guide
pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md