Added documentation for Grading Conflicts.

Author: williams-jack

app/controllers/grading_conflicts_controller.rb

@@ -7,19 +7,13 @@ class GradingConflictsController < ApplicationController
     before_action :require_admin_or_prof, only: [:delete, :update]
 
     def index
-        
         if current_user.course_professor?(@course) || current_user.site_admin
             @grading_conflicts = GradingConflict.where(course: @course)
         elsif current_user.course_assistant?(@course)
             @grading_conflicts = GradingConflict.where(course: @course, staff: current_user)
         else
             @grading_conflicts = GradingConflict.where(course: @course, student: current_user)
         end
-
-        # @active_and_inactive_conflicts = grading_conflicts.where(status: :inactive)
-        #     .or(grading_conflicts.where(status: :active))
-        # @pending_conflicts = grading_conflicts.where(status: :pending)
-
     end
 
     # TODO: Should there be a show method? May not be enough info/data

app/models/grading_conflict.rb

@@ -3,6 +3,9 @@ class GradingConflict < ApplicationRecord
   # A GradingConflict is either not considered in allocations (inactive),
   # used in allocating staff graders to students (active), or has been
   # requested by a student and is awaiting approval (pending).
+
+  # TODO: Should we have a *denied* status as well, for those 
+  # that are disapproved and thus not considered?
   enum status: [:inactive, :active, :pending]
 
   belongs_to :staff, class_name: "User"

doc/grading-conflict.md

@@ -0,0 +1,37 @@
+# Grading Conflicts
+
+**NOTE:** _Grader_ in the context of this document refers to a course grader/assistant -- a.k.a., a user who can grade a
+student's assignment. This is not the same as a StyleGrader, ManualGrader, etc.
+
+## Purpose
+
+A `GradingConflict` is a model developed to represent the existence of a conflict between a course grader/assistant 
+and a student. This is used to in conjunction with operations allocating graders to student submissions, in that a grader should
+NOT grade a student's submission if a conflict exists between them and the student.
+
+## Data Definition
+
+A `GradingConflict` contains the following data (fields):
+
+- `course`: The `Course` associated with the conflicted student and staff
+- `staff`: A `User` who is a Grader/Assistant for the course
+- `student`: A `User` who is a Student in the course
+- `status`: Status determining if the `GradingConflict` is in use/waiting approval. a `status` is an enumerable of either:
+    
+    - `:inactive` - Not used when determining grader allocations.
+    - `:active` - Used when determining grader allocations.
+    - `:pending` - Awaiting approval by a course professor or site admin.
+    
+-  `activity`: JSON used to log changes to the `GradingConflict`; more on this below.
+
+`GradingConflict` models also have timestamps for when they are created and updated.
+
+### The `activity` Field
+
+TODO
+
+### `status` Rules/Invariants
+
+TODO
+
+## Usage