aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Johannes Christ <[email protected]>2022-03-06 11:19:38 +0100
committerGravatar Johannes Christ <[email protected]>2022-03-06 11:19:38 +0100
commit073e09a07723db01691b9fdfc22cfbab037dad96 (patch)
tree32413f9a583916fb5c8ac5ac34349354ffb851d0
parentAdd a README for the API app (diff)
Mention human-readable migration names
-rw-r--r--pydis_site/apps/api/README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/pydis_site/apps/api/README.md b/pydis_site/apps/api/README.md
index 837a89fc..1c6358b3 100644
--- a/pydis_site/apps/api/README.md
+++ b/pydis_site/apps/api/README.md
@@ -19,7 +19,9 @@ Let's look over each of the subdirectories here:
- `migrations` is the standard Django migrations folder. You usually won't need
to edit this manually, as `python manage.py makemigrations` handles this for
- you in case you change our models.
+ you in case you change our models. (Note that when generating migrations and
+ Django doesn't generate a human-readable name for you, please supply one
+ manually using `-n add_this_field`.)
- `models` contains our Django model definitions. We put models into subfolders
relevant as to where they are used - in our case, the `bot` folder contains