From 100fbc08bf3ec399ef4c5ad4b757c5e12de5eaba Mon Sep 17 00:00:00 2001 From: Nathan Sprenkle Date: Thu, 14 Jan 2021 13:27:16 -0600 Subject: [PATCH] Update README and add PR template (#160) * Update README.md * Add CODEOWNERS * Add PR template * Add VS Code .gitignore --- .github/CODEOWNERS | 6 ++++++ .github/pull_request_template.md | 28 ++++++++++++++++++++++++++++ .gitignore | 5 ++++- README.md | 31 +++++++++++++++++++++---------- 4 files changed, 59 insertions(+), 11 deletions(-) create mode 100644 .github/CODEOWNERS create mode 100644 .github/pull_request_template.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..bf6756d4 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,6 @@ +# Code owners for frontend-app-gradebook, editable gradebook micro-frontend (MFE) + +# These owners will be the default owners for everything in +# the repo. Unless a later match takes precedence, they will +# be requested for review when someone opens a pull request. +* @edx/masters-devs-gta diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..7d0a6731 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,28 @@ +**TL;DR -** [ A short summary of what this PR does and why ] + +JIRA: [JIRA-XXXX](https://openedx.atlassian.net/browse/JIRA-XXXX) + +**What changed?** + +- [ More in depth breakdown of changes ] +- [ Peripheral things that got changed ] +- [ etc... ] + +**Developer Checklist** +- [ ] Test suites passing +- [ ] Received code-owner approving review +- [ ] Bumped version number [package.json](../package.json) + +**Testing Instructions** + +[ How should a reviewer test this PR? ] + +**Reviewer Checklist** + +Collectively, these should be completed by reviewers of this PR: + +- [ ] I've done a visual code review +- [ ] I've tested the new functionality + + +FYI: @edx/masters-devs-gta diff --git a/.gitignore b/.gitignore index 0926f27c..57d6a889 100755 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ .DS_Store .eslintcache -.idea node_modules npm-debug.log coverage @@ -14,3 +13,7 @@ dist/ *~ *.swo *.swp + +### Development environments ### +.idea +.vscode diff --git a/README.md b/README.md index 371d41eb..e460e033 100755 --- a/README.md +++ b/README.md @@ -4,13 +4,21 @@ [![license](https://img.shields.io/npm/l/@edx/frontend-app-gradebook.svg)](@edx/frontend-app-gradebook) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) -# gradebook +# Gradebook -Please tag **@edx/educator-neem** on any PRs or issues. +Gradebook allows course staff to view, filter, and override subsection grades for a course. Additionally for Masters courses, Gradebook enables bulk management of subsection grades. -## Introduction +Jump to: -The front-end of our editable Gradebook feature. +- [Should I use Gradebook in my course?](#should-i-use-gradebook-in-my-course) +- [Quickstart](#quickstart) + +For existing documentation see: + +- Basic Usage: [Review Learner Grades (read-the-docs)](https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/student_progress/course_grades.html#review-learner-grades-on-the-instructor-dashboard) +- Bulk Grade Management: [Override Learner Subsection Scores in Bulk (read-the-docs)](https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/student_progress/course_grades.html#review-learner-grades-on-the-instructor-dashboard) + +## Should I use Gradebook in my course? ### What does this offer over the legacy gradebook? @@ -44,7 +52,9 @@ depending on their needs. Instructors that expect to review grades infrequently to the problem in question will have a worse UX than the legacy gradebook provides. Instructors that rely on the graphs generated by the current gradebook might find the lack of autogenerated graphs to be frustrating. -## Installation +## Quickstart + +### Installation To install gradebook into your project: ``` @@ -64,7 +74,7 @@ Note that starting the container executes the `npm run start` script which will ## Configuring for local use in edx-platform Assuming you've got the UI running at `http://localhost:1994`, you can configure the LMS in edx-platform -to point to your local gradebook from the instructor dashboard by putting this settings in `lms/env/private.py`: +to point to your local gradebook from the instructor dashboard by putting this setting in `lms/env/private.py`: ``` WRITABLE_GRADEBOOK_URL = 'http://localhost:1994' ``` @@ -76,10 +86,11 @@ check the ``enabled`` and ``enabled for all courses`` boxes. 2. Waffle > Switches. Add the ``grades.assume_zero_grade_if_absent`` switch and make it active. -3. Waffle_utils > Waffle flag course overrides. You want to activate this flag for any course -in which you'd like to enable the gradebook. Add a course override flag using a course id and the flag name -``grades.writable_gradebook``. Make sure to check the ``enabled`` box. Alternatively, you could add this as a -regular waffle flag to enable the gradebook for all courses. +3. Waffle_utils > Waffle flag course overrides. Activate waffle flags for courses where you want to enable Gradebook functionality: + - Enable Gradebook by adding the ``grades.writable_gradebook`` add checking the ``enabled`` box. + - Enable Bulk Grade Management by adding the ``grades.bulk_management`` flag and checking the ``enabled`` box. + + Alternatively, you could add these as regular waffle flags to enable the functionality for all courses. **NOTE:** IF the above flags are not configured correctly, the gradebook may appear to work, but will return bogus numbers for grades. If your gradebook isn't accepting your changes, or the changes aren't resulting in sane,