From 3f589ab2c7bfe7ce13efadd03910fc555fd8314d Mon Sep 17 00:00:00 2001 From: Simon Chen Date: Mon, 7 Jun 2021 15:22:04 -0400 Subject: [PATCH] [Chore]: Add the readme file documenting the Agreements app (#27869) This is a simple housekeeping action to help other edx-platform development to understand the current state of Agreements app --- openedx/core/djangoapps/agreements/readme.rst | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 openedx/core/djangoapps/agreements/readme.rst diff --git a/openedx/core/djangoapps/agreements/readme.rst b/openedx/core/djangoapps/agreements/readme.rst new file mode 100644 index 0000000000..73dff3a46b --- /dev/null +++ b/openedx/core/djangoapps/agreements/readme.rst @@ -0,0 +1,23 @@ +############ +Agreements App +############ + +Status: Active + +Purpose +======= +The intention of this app is to host logic and data associated with the agreements learners needs to "sign" or "confirm". +These agreements includes, but not limited to, Honor Code to affirm they are who they say they are. + + +Responsibilities +================ + +The app intend to store all logic associated with agreements edX needs to display and record for either learners or educators. +Currently, the app only store the Honor Code signature for learners. +In order to reinforce academic integrity, learners will be required to agree to the honor code before entering the first assignment on paid track. + +Glossary +======== +* *Signature*: It's a record of any form to store user's action against an agreement or code. For example: A record denoting the time of a user's agreement to Honor Code of a course. +