Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 4.81 KB

CONTRIBUTING.md

File metadata and controls

70 lines (48 loc) · 4.81 KB

Contribution Guide

An overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Getting Started

All the questions are stored in .yaml files. For more information about .yaml files, please visit:

Add questions

Segregation

Questions are divided into five broad categories:

To request the addition of a new category you can create an issue.

YAML list of acceptable values for each key

Each question is stored in a key-value format. There are a fixed set of keys, some of which must neccessarily have non-NULL values. Here is the list of keys alongwith the list of values they can accept:

Key Description Accepted Values
title The title of the question (for later review) any string
type This specifies the type of question (e.g., MCQs, descriptive, etc.). mcq, descriptive, num
text The main body of the question. any string
opt The list of options in case the question is a multiple choice question. array, NULL
ans The final answer. any string
q_img The path of the image file(s) that you may want to display with the question. array, NULL
sol Further explanation that you may include for how you arrived at the answer. any string, NULL
sol_img The path of the image file(s) that you may want to display with the solution. array, NULL
tags You can assign tags to your question based on the domains it requires knowledge of. List of Tags
diff The difficulty level of the question easy, medium, hard
ref References (Where did you encounter the question) any string

To request the addition of a new key you can create an issue.

Issues

Create a new Issue

If you spot a problem in this repository, or need to request a new tag, or a new key, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an Issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information.

Style guide

We follow standard effective yaml guidelines. You can refer to this guide for more information.

Keep these in mind while creating a pull request:

  • Don't forget to link PR to issue if you are solving one.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments.

First time contributor?

If you are new to contributing to open source, this guide helps explain why, what, and how to get involved. Here are some resources to help you get started with open source contributions:

We thank you for investing your time in contributing to this project!