Things to keep in mind as working on wall_e

• 1. To make any needed changes to the models
• 2. Local Testing Tips
• 3. Before opening a PR
• 4. Test Cases
• FAQs
• Variable Initialization Details

1. To make any needed changes to the models

1.1. Setup wall_e_models locally

git clone <fork of https://github.com/CSSS/wall_e_models.git> #do not do this in the wall_e repo

cd /path/to/walle_repo/wall_e
ln -sn /path/to/wall_e_models/wall_e_models wall_e_models

1.2. To save changes made to wall_e_models

cd /path/to/wall_e_models
# git add, commit and push and changes to your forked models repo and then open a PR to https://github.com/CSSS/wall_e_models.git

2. Local Testing Tips

• if you are done deving locally, you can run /delete_log_channels to delete all the log channels that wall_e created for better visibility into which cogs had which errors
• If you want to wipe a channel after populating it with a lot of test messages, just run /purge_messages <last_x_messages_to_delete>

3. Before opening a PR

Please submit PRs one week before they need to be merged.

Validating the code locally:

./CI/validate_and_deploy/1_validate/run_local_formatting_test.sh

FAQs

Issue: Experiencing a networking issue with docker-compose

ERROR: could not find an available, non-overlapping IPv4 address pool among the defaults to assign to the network

resolution: If you are using a VPN, please disconnect and try again.

Variable Initialization Details

This may be outdated at this point, not sure anymore

How the Variable needs to be initialized [only relevant to you if you like granularized variable initializations]

Variable	Dockerized			Non-Dockerized
	env variable	wall_e.env	local.ini	env variable	local.ini
ENVIRONMENT		X		x
COMPOSE_PROJECT_NAME	X			X
POSTGRES_PASSWORD	X	X		x
DOCKERIZED		-	-	-	-
WALL_E_DB_USER		X		x
WALL_E_DB_PASSWORD		X		x
WALL_E_DB_DBNAME		X		x
DB_ENABLED		-	-	-	-
HOST		-	-	x
ORIGIN_IMAGE	X
BOT_LOG_CHANNEL		-	-	-	-
BOT_GENERAL_CHANNEL		-	-	-	-
DB_PORT		X		X

X indicates that its necessary to be declared in that way
'-' indicates that the user can choose to declare it only that way