Skip to content

Commit 177597b

Browse files
docs: OEP-67: clarify how devDependencies should be used (#615)
1 parent 2c6bf85 commit 177597b

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

oeps/best-practices/oep-0067-bp-tools-and-technology.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,16 @@ Frontend Technology Selection
254254
don't unintentionally increase the size of our JavaScript bundles, we utilize BundleWatch
255255
for automated bundle size monitoring.
256256

257+
#. **Development dependencies should be separated into devDependencies**
258+
259+
**Rationale**: To keep installation and deployment of our MFEs as fast as
260+
possible, the "dependencies" field in ``package.json`` should reference only
261+
the packages needed to build the bundle of the MFE (this includes webpack via
262+
frontend-build, as well as any dependencies used in the actual MFE/React
263+
code). Any dependencies used only for testing, linting, formatting, or other
264+
development tasks should be put into "devDependencies" (e.g. Jest, eslint,
265+
TypeScript, ``@types/`` packages, etc.).
266+
257267
Backend Technology Selection
258268
============================
259269

@@ -330,6 +340,8 @@ Change History
330340
2024-07-25
331341
==========
332342

343+
* Added "Development dependencies should be separated into devDependencies"
344+
* `Pull request #615 <https://github.com/openedx/open-edx-proposals/pull/615>`_
333345
* Changed guidance on React state/data loading to recommend React Query instead of Redux
334346
* Updated JavaScript/TypeScript guidance
335347
* `Pull request #616 <https://github.com/openedx/open-edx-proposals/pull/616>`_

0 commit comments

Comments
 (0)