From 3a04fbf18ac5821fdcf738d427768729dad351f5 Mon Sep 17 00:00:00 2001 From: Mashal Malik <107556986+Mashal-m@users.noreply.github.com> Date: Tue, 31 Oct 2023 23:20:01 +0500 Subject: [PATCH] refactor: updated README file to reflect template changes (#124) * refactor: updated README file to reflect template changes * docs: fixed some typos --------- Co-authored-by: ilee2u --- README.rst | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 68 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 9c4c5e2a..61eb67cc 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,18 @@ +########################## frontend-lib-special-exams -================================= +########################## + +******* +Purpose +******* This is a react library responsible for extending learning app with special exams functionality, e.g. proctored/timed exams. -Set up instructions --------------------------- +*************** +Getting Started +*************** + +Installation +============ 1. Clone your new repo: @@ -17,15 +26,69 @@ Set up instructions ``cd frontend-lib-special-exams && npm install`` +******************* Build Process Notes -------------------- +******************* **Production Build** The production build is created with ``npm run build``. +********************* Internationalization --------------------- +********************* Please see `edx/frontend-platform's i18n module `_ for documentation on internationalization. The documentation explains how to use it, and the `How To `_ has more detail. +************ +Contributing +************ + +Contributions are very welcome. Please read `How To Contribute`_ for details. + +.. _How To Contribute: https://openedx.org/r/how-to-contribute + +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. + +************ +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`_. Because this is a +frontend repository, the best place to discuss it would be in the `#wg-frontend +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/frontend-lib-special-exams/issues + +For more information about these options, see the `Getting Help`_ page. + +.. _Slack invitation: https://openedx.org/slack +.. _community Slack workspace: https://openedx.slack.com/ +.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6 +.. _Getting Help: https://openedx.org/community/connect + +**************************** +The Open edX Code of Conduct +**************************** + +All community members are expected to follow the `Open edX Code of Conduct`_. + +.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/ + +************************** +Reporting Security Issues +************************** + +Please do not report security issues in public. Please email security@openedx.org. \ No newline at end of file