Contributing.md

Contributing Guide

If you have ChatGPT Plus

1. Use this GPT to generate in the correct format.
2. In VSCode, Setup Markdown Extension
3. Paste in the problem and solution.
4. You can even paste screenshots from Slack of the issue. In the prompt, mention the name of who is Giving the Solution (i.e. TA or Professor)

---

Welcome to our project's contribution guide! We're excited to have you on board and look forward to your valuable contributions. This document outlines the process and guidelines for contributing to this repository, especially for adding new troubleshooting guides.

Structure for Troubleshooting Guides

When contributing a new troubleshooting guide, please structure your content as follows:

1. Problem:

   • Clearly state the problem. This should be a concise description of what the issue is.

2. Solution:

   • Provide a direct solution or workaround that can be quickly implemented to address the problem.

3. Explanation:

   • Offer a detailed explanation of the problem and the solution. This should include why the problem occurs and how the solution resolves it.

Writing Your Guide

Please adhere to the following format when writing your guide:

# Page Title

---

## Problem: <title of problem>

Briefly describe the problem.

### Solution

Provide the immediate solution or workaround.

<details markdown="1"> 
<summary>Explanation</summary>
1. In Depth Explanation
</details>

---

Offer a detailed explanation of both the problem and the solution.

• Include any relevant details or context.
• If applicable, provide step-by-step instructions.
• Use clear and concise language.