Skip to content

Commit

Permalink
Merge pull request #97 from MIT-Emerging-Talent/adding-gifs
Browse files Browse the repository at this point in the history
adding gifs to readmes
  • Loading branch information
linahKhayri authored Jan 10, 2025
2 parents a140835 + 5ebe9df commit b96c057
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 33 deletions.
47 changes: 33 additions & 14 deletions solutions/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,42 @@
# Solutions
# **Welcome to the Solutions Directory!** 💡

Welcome to the **Solutions** directory of Group 24! This folder contains the implementations and solutions to the challenges or problems assigned to the group by its members.
![Descriptive Text](https://media0.giphy.com/media/v1.Y2lkPTc5MGI3NjExMmh4N3N4YW41eGp5bWtnNXZ1Z2Z2eHhmeDQyNXlreTlqemxpdGcybiZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/iIqmM5tTjmpOB9mpbn/giphy.webp)

## Directory Structure
Welcome to the **Solutions** directory of Group 24! This folder contains the implementations and solutions to the challenges and problems assigned to the group by its members. It’s where the magic happens! ✨

- Each task or problem will have its own folder or file, clearly named for easy identification.
- Code solutions are typically written in python.
---

## Contribution Guidelines
## **Directory Structure: Organized for Success** 📂

1. Ensure your solution is optimized and well-documented.
2. Follow the coding standards outlined by the team.
3. Include comments in your code to explain key logic.
4. Test your solutions locally before submitting them.
- **Each task or problem** will have its own **folder or file**, clearly named for easy identification.
- Code solutions are **typically written in Python** 🐍, making them accessible and easy to maintain.

## Status
---

- We continuously improve and refine our solutions. Please check for updates regularly!
## **Contribution Guidelines: Together, We Code!** 💻

## Contact
To keep our codebase clean and efficient, follow these best practices:

For questions or suggestions regarding the solutions, reach out to the team members.
1. **Optimize and document** your solution for clarity and performance.
2. Follow the **coding standards** outlined by the team to ensure consistency.
3. **Include comments** in your code to explain key logic and reasoning.
4. **Test your solutions locally** before submitting them to ensure functionality.

---

## **Status: Continuous Improvement** 🔄

- We are always looking for ways to **improve and refine** our solutions!
- Be sure to **check for updates regularly** to stay in sync with the latest changes.

---

## **Contact: Let’s Collaborate!** 📬

If you have any questions or suggestions regarding the solutions, feel free to reach out to the team members. We’re all in this together! 🤝

<!--
The HTML <img> tag is used to control the image's width (800px), ensuring a consistent appearance.
-->

<img src="https://img1.picmix.com/output/stamp/normal/1/7/6/9/2289671_302fc.gif" alt="sparks" width="800" height="100"/>
57 changes: 38 additions & 19 deletions solutions/tests/README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,57 @@
# Tests
# **Welcome to the Tests Directory!** 🧪

![Descriptive Text](https://y.yarn.co/9c5f98e5-9c1d-4746-82b3-f1ea594fb5b5_text.gif)

This is the **Tests** directory of Group 24, dedicated to validating the solutions and ensuring the functionality and correctness of the implementations.

## Purpose
---

## **Purpose: The Quest for Perfection** 🎯

The tests are designed to:

1. Verify the correctness of solutions.
2. Ensure edge cases and special conditions are handled properly.
3. Maintain the reliability and robustness of the codebase.
1. **Verify the correctness** of solutions.
2. **Ensure edge cases and special conditions** are handled properly.
3. **Maintain the reliability and robustness** of the codebase.

---

## **Directory Structure: Organized for Success** 📂

## Directory Structure
- Each solution will have a corresponding **test file or folder**.
- Tests are **categorized** based on the problem/task they validate. 📑

- Each solution will have a corresponding test file or folder.
- Tests are categorized based on the problem/task they validate.
---

## Writing Tests
## **Writing Tests: The Art of Validation** 🎨

- Use consistent naming conventions for test files
- Use **consistent naming conventions** for test files.
- Follow the team's testing framework or tools (e.g., **PyTest**).
- Cover all edge cases, normal cases, and error cases.
- **Cover all edge cases, normal cases, and error cases**. 🌐

## Running Tests
---

## **Running Tests: Watch Your Code Shine! 🌟**

1. Navigate to this directory in your terminal.
2. Use the designated command for the testing framework
3. Ensure all tests pass before pushing changes.
2. Use the designated command for the testing framework.
3. Ensure all tests **pass** before pushing changes.

---

## Contribution Guidelines
## **Contribution Guidelines: Together, We Rise** 💪

1. Write clear and concise test cases.
2. Ensure test cases are independent of each other.
3. Document the purpose of each test case in comments.
1. **Write clear and concise test cases**.
2. Ensure **test cases are independent** of each other.
3. **Document the purpose** of each test case in comments. 💬

## Contact
---

## **Contact: Let’s Build, Improve, and Learn** 📬

If you encounter any issues with the tests or have suggestions for improvement, feel free to contact the team members or test maintainers.

<!--
The HTML <img> tag is used to control the image's width (800px), ensuring a consistent appearance.
-->
<img src="https://img1.picmix.com/output/stamp/normal/1/7/6/9/2289671_302fc.gif" alt="sparks" width="800" height="100"/>

0 comments on commit b96c057

Please sign in to comment.