diff --git a/README.rst b/README.rst index 832f3cc..532f045 100644 --- a/README.rst +++ b/README.rst @@ -39,22 +39,12 @@ The parts of this MFE that can be customized in that manner are documented `here Contributing ------------ -A core goal of this app is to provide a clean experimentation interface. To promote this end, we have provided a -silo'ed code directory at ``src/widgets`` in which contributors should add their custom widget components. In order to -ensure our ability to maintain the code stability of the app, the code for these widgets should be strictly contained -within the bounds of that directory. +Contributions are very welcome. Please read `So you want to contribute to Open edX `_ for details on how to get started as an Open edX contributor. -Once written, the widgets can be configured into one of our widget containers at ``src/containers/WidgetContainers``. -This can include conditional logic, as well as Optimizely triggers. It is important to note that our integration tests -will isolate and ignore these containers, and thus testing your widget is the response of the creator/maintainer of the -widget itself. +This project is currently accepting all types of contributions — bug fixes, security fixes, maintenance work, or new features. +However, if you intend to add a new feature, make sure it has gone through the `Product Review process `_. -Some guidelines for writing widgets: - -* Code for the widget should be strictly confined to the ``src/widgets`` directory. -* You can load data from the redux store, but should not add or modify fields in that structure. -* Network events should be managed in component hooks, though can use our ``data/constants/requests:requestStates`` for - ease of tracking the request states. +When proposing a change, create an issue in this repo to get the discussion started. License ------- diff --git a/src/App.jsx b/src/App.jsx index e9f3e29..2c148f9 100755 --- a/src/App.jsx +++ b/src/App.jsx @@ -22,7 +22,7 @@ import track from 'tracking'; import fakeData from 'data/services/lms/fakeData/courses'; -import AppWrapper from 'containers/WidgetContainers/AppWrapper'; +import AppWrapper from 'containers/AppWrapper'; import LearnerDashboardHeader from 'containers/LearnerDashboardHeader'; import { getConfig } from '@edx/frontend-platform'; diff --git a/src/App.test.jsx b/src/App.test.jsx index 7383cf5..102d379 100644 --- a/src/App.test.jsx +++ b/src/App.test.jsx @@ -13,7 +13,7 @@ jest.mock('@edx/frontend-component-footer', () => ({ })); jest.mock('containers/Dashboard', () => jest.fn(() =>
Dashboard
)); jest.mock('containers/LearnerDashboardHeader', () => jest.fn(() =>
LearnerDashboardHeader
)); -jest.mock('containers/WidgetContainers/AppWrapper', () => jest.fn(({ children }) =>
{children}
)); +jest.mock('containers/AppWrapper', () => jest.fn(({ children }) =>
{children}
)); jest.mock('data/redux', () => ({ selectors: 'redux.selectors', actions: 'redux.actions', diff --git a/src/containers/WidgetContainers/AppWrapper/index.jsx b/src/containers/AppWrapper/index.jsx similarity index 100% rename from src/containers/WidgetContainers/AppWrapper/index.jsx rename to src/containers/AppWrapper/index.jsx diff --git a/src/plugin-slots/WidgetSidebarSlot/index.jsx b/src/plugin-slots/WidgetSidebarSlot/index.jsx index 370027c..01a848b 100644 --- a/src/plugin-slots/WidgetSidebarSlot/index.jsx +++ b/src/plugin-slots/WidgetSidebarSlot/index.jsx @@ -1,7 +1,7 @@ import React from 'react'; import { PluginSlot } from '@openedx/frontend-plugin-framework'; -import LookingForChallengeWidget from 'widgets/LookingForChallengeWidget'; +import LookingForChallengeWidget from 'plugins/LookingForChallengeWidget'; // eslint-disable-next-line arrow-body-style export const WidgetSidebarSlot = () => ( diff --git a/src/widgets/LookingForChallengeWidget/index.jsx b/src/plugins/LookingForChallengeWidget/index.jsx similarity index 100% rename from src/widgets/LookingForChallengeWidget/index.jsx rename to src/plugins/LookingForChallengeWidget/index.jsx diff --git a/src/widgets/LookingForChallengeWidget/index.scss b/src/plugins/LookingForChallengeWidget/index.scss similarity index 100% rename from src/widgets/LookingForChallengeWidget/index.scss rename to src/plugins/LookingForChallengeWidget/index.scss diff --git a/src/widgets/LookingForChallengeWidget/index.test.jsx b/src/plugins/LookingForChallengeWidget/index.test.jsx similarity index 100% rename from src/widgets/LookingForChallengeWidget/index.test.jsx rename to src/plugins/LookingForChallengeWidget/index.test.jsx diff --git a/src/widgets/LookingForChallengeWidget/messages.js b/src/plugins/LookingForChallengeWidget/messages.js similarity index 100% rename from src/widgets/LookingForChallengeWidget/messages.js rename to src/plugins/LookingForChallengeWidget/messages.js diff --git a/src/widgets/LookingForChallengeWidget/track.js b/src/plugins/LookingForChallengeWidget/track.js similarity index 100% rename from src/widgets/LookingForChallengeWidget/track.js rename to src/plugins/LookingForChallengeWidget/track.js