You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+6-16Lines changed: 6 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,22 +39,12 @@ The parts of this MFE that can be customized in that manner are documented `here
39
39
Contributing
40
40
------------
41
41
42
-
A core goal of this app is to provide a clean experimentation interface. To promote this end, we have provided a
43
-
silo'ed code directory at ``src/widgets`` in which contributors should add their custom widget components. In order to
44
-
ensure our ability to maintain the code stability of the app, the code for these widgets should be strictly contained
45
-
within the bounds of that directory.
46
-
47
-
Once written, the widgets can be configured into one of our widget containers at ``src/containers/WidgetContainers``.
48
-
This can include conditional logic, as well as Optimizely triggers. It is important to note that our integration tests
49
-
will isolate and ignore these containers, and thus testing your widget is the response of the creator/maintainer of the
50
-
widget itself.
51
-
52
-
Some guidelines for writing widgets:
53
-
54
-
* Code for the widget should be strictly confined to the ``src/widgets`` directory.
55
-
* You can load data from the redux store, but should not add or modify fields in that structure.
56
-
* Network events should be managed in component hooks, though can use our ``data/constants/requests:requestStates`` for
57
-
ease of tracking the request states.
42
+
Contributions are very welcome. Please read `So you want to contribute to Open edX <https://docs.openedx.org/en/latest/developers/quickstarts/so_you_want_to_contribute.html>`_ for details on how to get started as an Open edX contributor.
43
+
44
+
This project is currently accepting all types of contributions — bug fixes, security fixes, maintenance work, or new features.
45
+
However, if you intend to add a new feature, make sure it has gone through the `Product Review process <https://openedx.atlassian.net/wiki/spaces/COMM/pages/3875962884/How+to+submit+an+open+source+contribution+for+Product+Review>`_.
46
+
47
+
When proposing a change, create an issue in this repo to get the discussion started.
0 commit comments