Skip to content

Commit

Permalink
docs: OEP-67: clarify how devDependencies should be used (#615)
Browse files Browse the repository at this point in the history
  • Loading branch information
bradenmacdonald authored and davidjoy committed Aug 28, 2024
1 parent 78125dd commit 4f0e6c2
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions oeps/best-practices/oep-0067-bp-tools-and-technology.rst
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,16 @@ Frontend Technology Selection
don't unintentionally increase the size of our JavaScript bundles, we utilize BundleWatch
for automated bundle size monitoring.

#. **Development dependencies should be separated into devDependencies**

**Rationale**: To keep installation and deployment of our MFEs as fast as
possible, the "dependencies" field in ``package.json`` should reference only
the packages needed to build the bundle of the MFE (this includes webpack via
frontend-build, as well as any dependencies used in the actual MFE/React
code). Any dependencies used only for testing, linting, formatting, or other
development tasks should be put into "devDependencies" (e.g. Jest, eslint,
TypeScript, ``@types/`` packages, etc.).

Backend Technology Selection
============================

Expand Down Expand Up @@ -330,6 +340,8 @@ Change History
2024-07-25
==========

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

0 comments on commit 4f0e6c2

Please sign in to comment.