docs: add recommendation for ADR

openedx · Mar 1, 2023 · 7bdb2e5 · 7bdb2e5
1 parent 0b1f15b
commit 7bdb2e5
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/oeps/best-practices/oep-0049-django-app-patterns.rst b/oeps/best-practices/oep-0049-django-app-patterns.rst
@@ -267,6 +267,13 @@ Do note that even if you expose your tasks through ``api.py`` to be used by othe
 still be configured with the ``tasks`` import name, as the celery identifier for your task (as set by the celery
 decorator) is based off the original file.
 
+docs/decisions/0001-purpose-of-this-repo.rst or 0001-purpose-of-this-app.rst
+============================================================================
+
+This should be an architectural decision record (ADR) describing the decision behind adding the app. Future ADRs should also be placed in this directory. See more about what should go in ADRs in OEP-0019_
+
+.. _OEP-0019: https://open-edx-proposals.readthedocs.io/en/latest/oep-0019-bp-developer-documentation.html#adrs
+
 Consequences
 ************
 
@@ -279,6 +286,7 @@ Change History
 ==========
 
 * Changed type from "Architecture" to "Best Practice"
+* Added section for an ADR justifying the new app
 
 2021-04-23
 ==========