Skip to content

Latest commit

 

History

History
114 lines (77 loc) · 3.88 KB

README.rst

File metadata and controls

114 lines (77 loc) · 3.88 KB

openedx-tutor-plugins

License status-badge

Purpose

This repository houses a collection of Tutor plugins maintained by the Open edX community:

Plugin Status (Experimental, Production, or Deprecated)
tutor-contrib-learner-dashboard-mfe Deprecated
tutor-contrib-test-legacy-js "Production" (Supported For Developers)

Getting Started

Generally, assuming Tutor is installed, to add a plugin in this repository to your deployment environment you would:

git clone git@github.com:openedx/openedx-tutor-plugins
cd openedx-tutor-plugins/plugins/<plugin-name>
pip install -e .
tutor plugins enable <plugin-name>

Make sure to check each plugin's README file for more details.

Developing

To create a new Tutor plugin in this repository, use the Tutor plugin cookiecutter in a directory under plugins, and commit results.

Getting Help

If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace. And because this is a Tutor plugin repository, the best place to discuss it would be in the #tutor channel.

For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.

https://github.com/openedx/openedx-tutor-plugins/issues

For more information about these options, see the Getting Help page.

License

The code in this repository is licensed under the AGPLv3 unless otherwise noted.

Please see LICENSE for details.

Contributing

Contributions are very welcome. Please read How To Contribute for details.

This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to have a discussion about your new feature idea with the maintainers prior to beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.

The Open edX Code of Conduct

All community members are expected to follow the Open edX Code of Conduct.

People

The assigned maintainers for this component and other project details may be found in Backstage. Backstage pulls this data from the catalog-info.yaml file in this repo.

Reporting Security Issues

Please do not report security issues in public, and email security@openedx.org instead.