Skip to content

Commit

Permalink
added 2 blank markdown files to fill in on github.com
Browse files Browse the repository at this point in the history
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
  • Loading branch information
JohnLu2004 authored and JohnLu2004 committed Aug 6, 2024
1 parent 762d4ed commit e275dff
Show file tree
Hide file tree
Showing 3 changed files with 129 additions and 1 deletion.
28 changes: 28 additions & 0 deletions docs/contributing-evaluations.md
Original file line number Diff line number Diff line change
@@ -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)
68 changes: 68 additions & 0 deletions docs/contributing-questions.md
Original file line number Diff line number Diff line change
@@ -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 },
],
};
```
34 changes: 33 additions & 1 deletion docs/contributing-solutions.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit e275dff

Please sign in to comment.