From e275dffdf22c3a55d7dfacb98e306dc6637cd7eb Mon Sep 17 00:00:00 2001
From: John Lu <john.lu10212004@gmail.com>
Date: Tue, 6 Aug 2024 07:00:38 -0400
Subject: [PATCH] added 2 blank markdown files to fill in on github.com Update
 and rename contributing-exams.md to contributing-evaluations.md Update
 contributing-questions.md Update contributing-solutions.md Update
 contributing-solutions.md Reformatted 4 md files

---
 docs/contributing-evaluations.md | 28 +++++++++++++
 docs/contributing-questions.md   | 68 ++++++++++++++++++++++++++++++++
 docs/contributing-solutions.md   | 34 +++++++++++++++-
 3 files changed, 129 insertions(+), 1 deletion(-)
 create mode 100644 docs/contributing-evaluations.md
 create mode 100644 docs/contributing-questions.md

diff --git a/docs/contributing-evaluations.md b/docs/contributing-evaluations.md
new file mode 100644
index 00000000..a5496a46
--- /dev/null
+++ b/docs/contributing-evaluations.md
@@ -0,0 +1,28 @@
+# Adding an Evaluation
+
+## Navigate to Correct Directory
+
+Navigate to `src > content > evaluations`
+
+![image](https://github.com/user-attachments/assets/afd52523-fc0f-4e28-82e6-cc052f74bc93)
+
+If there is a directory for the course, then enter that directory (e.g. comp2804)
+
+If there is no folder for the course, create a new directory (e.g. comp2402)
+
+## Adding New Evaluation to Directory
+
+Add a new evaluation in this format: year-term-evaluation_type.md (e.g. 2023-winter-midterm.md)
+
+Add and fill in the following information...
+
+- title:
+- path:
+- author:
+- course:
+- created_at:
+- questions:
+
+E.g:
+
+![image](https://github.com/user-attachments/assets/0c1240bc-53b2-4f2d-8990-ec3c3ff647c0)
diff --git a/docs/contributing-questions.md b/docs/contributing-questions.md
new file mode 100644
index 00000000..8cfe42a9
--- /dev/null
+++ b/docs/contributing-questions.md
@@ -0,0 +1,68 @@
+# Adding a Question
+
+## Navigate to Questions Directory
+
+Navigate to `src > content > questions`
+
+Enter correct course directory
+
+- If there is a course directory for the evaluation, then enter that directory (e.g. comp2804)
+- If there is no course directory for the evaluation, create a new directory (e.g. comp2402)
+
+Enter correct evaluation directory
+
+- If there is a directory for the evaluation, then enter that directory (e.g. 2013-fall-midterm)
+- If there is no directory for the evaluation, create a new directory (e.g. 2023-winter-final)
+
+Create numbered directory. (e.g. Directory for Question 1 is `1`)
+
+## Adding New Question to Directory
+
+### Creating index.md
+
+Create a file called `index.md`
+
+Add and fill in the following information
+
+- title
+- path
+- type
+- author
+- question
+- solution(if there is one)
+- generator(if there is one)
+- tags
+
+E.g
+
+![image](https://github.com/user-attachments/assets/b639cf2d-979f-41b2-83c3-eaf02b7183c7)
+
+### Creating question.ts
+
+Create a file called `question.ts`
+
+Use the following template to add question and options
+
+```
+import type { MultipleChoiceQuestion } from "@common/MultipleChoiceQuestionGenerator";
+
+const body = String.raw`
+What is the answer?
+`;
+
+const label1 = String.raw`This is option 1`;
+const label2 = String.raw`This is option 2`;
+const label3 = String.raw`This is option 3`;
+const label4 = String.raw`Options can have latex: $13 \cdot 5^{13}$`;
+
+export const question: MultipleChoiceQuestion = {
+  body: body,
+  options: [
+    { label: label1, correct: true },
+    { label: label2, correct: false },
+    { label: label3, correct: false },
+    { label: label4, correct: false },
+  ],
+};
+
+```
diff --git a/docs/contributing-solutions.md b/docs/contributing-solutions.md
index 29cd508b..336c15f3 100644
--- a/docs/contributing-solutions.md
+++ b/docs/contributing-solutions.md
@@ -1 +1,33 @@
-# Contributing Solutions
+# Contributing a Solution
+
+## Navigate to Questions Directory
+
+Navigate to `src > content > questions`
+
+Enter correct course directory
+
+- If there is a course directory for the evaluation, then enter that directory (e.g. comp2804)
+- If there is no course directory for the evaluation, create a new directory (e.g. comp2402)
+
+Enter correct evaluation directory
+
+- If there is a directory for the evaluation, then enter that directory (e.g. 2013-fall-midterm)
+- If there is no directory for the evaluation, create a new directory (e.g. 2023-winter-final)
+
+Create numbered directory. (e.g. Directory for Question 1 is `1`)
+
+## Adding a Solution
+
+Create a `solution.md` file
+
+There is no specific format. Here are a list of tips and tricks...
+
+- Hit enter twice to have content go on the next line
+- For values, use latex $$: ``$5 \cdot 3$`` renders as 5 x 3
+- You can use html tags
+- `<ul></ul>` tags with `<li>` inside
+- `<br/>` if you don't want to hit enter twice to create newline
+
+E.g.
+
+![image](https://github.com/user-attachments/assets/3d8dbe80-604c-45b2-bd5f-457f7dde167d)