Skip to content

Commit 5086816

Browse files
Add Django 6.0 allowlist to contributing guide (#3073)
* Add Django 6.0 allowlist to contributing guide Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com> * Add Django 6.0 allowlist to contributing guide Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com> * Add Django 6.0 allowlist to contributing guide Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com> --------- Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
1 parent 49544a2 commit 5086816

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,14 @@ rm -r .mypy_cache
7777

7878
### Testing stubs with `stubtest`
7979

80-
Run `./scripts/stubtest.sh` to test that stubs and sources are in-line.
80+
Run [`./scripts/stubtest.sh`](scripts/stubtest.sh) to test that stubs and sources are in-line.
8181

8282
We have some special files to allow errors:
8383

84-
1. `scripts/stubtest/allowlist.txt` where we store things that we really don't care about: hacks, django internal utility modules, things that are handled by our plugin, things that are not representable by type system, etc
85-
2. `scripts/stubtest/allowlist_todo.txt` where we store all errors there are right now. Basically, this is a TODO list: we need to work through this list and fix things (or move entries to real `allowlist.txt`). In the end, ideally we can remove this file.
86-
3. `scripts/stubtest/allowlist_todo_django52.txt` where we store new errors from the Django 5.0 to 5.2 upgrade. This is an extra TODO list.
84+
1. [`scripts/stubtest/allowlist.txt`](scripts/stubtest/allowlist.txt) - Permanent exclusions, e.g. internal utilities, plugin-handled items, type system limitations.
85+
2. [`scripts/stubtest/allowlist_todo.txt`](scripts/stubtest/allowlist_todo.txt) - General backlog of stub errors to fix or move to permanent allowlist.
86+
3. [`scripts/stubtest/allowlist_todo_django52.txt`](scripts/stubtest/allowlist_todo_django52.txt) - Django 5.2-specific API changes requiring stub updates.
87+
4. [`scripts/stubtest/allowlist_todo_django60.txt`](scripts/stubtest/allowlist_todo_django60.txt) - Django 6.0-specific API changes requiring stub updates.
8788

8889
You might also want to disable `incremental` mode while working on `stubtest` changes.
8990
This mode leads to several known problems (stubs do not show up or have strange errors).

0 commit comments

Comments
 (0)