6.x onramp

CHANGES.rst

@@ -3,8 +3,35 @@ CHANGES
 
 master (unreleased)
 -------------------
-_This is where upcoming changes will be._
+*This is where upcoming changes will be.*
 
+6.0 (unreleased)
+----------------
+
+Breaking change: Missing ``DEFAULT_AUTO_FIELD``
+"""""""""""""""""""""""""""""""""""""""""""""""
+This sets a ``DEFAULT_AUTO_FIELD`` to ``BigAutoField`` for robots in ``AppConfig``. Previously,
+there was no app configuration or setting for this. (#134, thank you @jan-szejko-steelseries)
+
+Robots 5.0 included a ``BigAutoField`` migration file for django 3.2 support (see #112),
+however, this caused an extra migration to be created to set ``django.db.models.AutoField``
+for certain users (see #124).
+
+**Breaking: Migration issues**
+
+New django sites should work fine.
+
+*Existing sites that manually created migrations for robots 5.0:*
+
+If you ran ``./manage.py makemigrations`` to bypass the #112 issue, you may need to resolve
+this manually if a custom migration you made for robots was applied in ``django_migrations``.
+
+Resources:
+- https://docs.djangoproject.com/en/4.1/releases/3.2/#customizing-type-of-auto-created-primary-keys
+- https://docs.djangoproject.com/en/3.2/ref/settings/#std-setting-DEFAULT_AUTO_FIELD
+
+Maintenance
+"""""""""""
 - Remove django-south migrations folder (#138)
 
 5.0 (2022-01-08)

docs/index.rst

@@ -157,6 +157,30 @@ settings file::
 This tells Django to cache the ``robots.txt`` for 24 hours (86400 seconds).
 The default value is ``None`` (no caching).
 
+Developing
+==========
+
+To run tests, create a virtualenv:
+
+    virtualenv --python 3.10 .venv
+
+Source it:
+
+    . .venv/bin/activate
+
+    # or if you use source
+    source .venv/bin/activate
+
+Install:
+
+    pip install -e .
+    pip install -r tests/requirements.txt
+    pip install django
+
+Run the tests:
+
+    env PYTHONPATH=. DJANGO_SETTINGS_MODULE=tests.settings django-admin test robots -v2
+
 Bugs and feature requests
 =========================