From c3a8d91dbbab5b933a87f7e9c13b5ce124499d18 Mon Sep 17 00:00:00 2001 From: Abel Mesfin Teka Date: Fri, 3 Jan 2025 19:19:51 +0300 Subject: [PATCH 1/3] solutions and tests readme updated. --- solutions/README.md | 22 ++++++++++++++++++++++ solutions/tests/README.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) diff --git a/solutions/README.md b/solutions/README.md index 9852346d2..f30bf42dc 100644 --- a/solutions/README.md +++ b/solutions/README.md @@ -1 +1,23 @@ # Solutions + +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 the group. + +## Directory Structure + +- 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 + +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. + +## Status + +- We continuously improve and refine our solutions. Please check for updates regularly! + +## Contact + +For questions or suggestions regarding the solutions, reach out to the team members. diff --git a/solutions/tests/README.md b/solutions/tests/README.md index 007eb9551..b988dc033 100644 --- a/solutions/tests/README.md +++ b/solutions/tests/README.md @@ -1 +1,38 @@ # Tests + +This is the **Tests** directory of Group 24, dedicated to validating the solutions and ensuring the functionality and correctness of the implementations. + +## Purpose + +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. + +## Directory Structure + +- Each solution will have a corresponding test file or folder. +- Tests are categorized based on the problem/task they validate. + +## Writing Tests + +- Use consistent naming conventions for test files (e.g., `test_.py`). +- Follow the team's testing framework or tools (e.g., **PyTest**). +- Cover all edge cases, normal cases, and error cases. + +## Running Tests + +1. Navigate to this directory in your terminal. +2. Use the designated command for the testing framework (e.g., `pytest`, `npm test`, etc.). +3. Ensure all tests pass before pushing changes. + +## Contribution Guidelines + +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 + +If you encounter any issues with the tests or have suggestions for improvement, feel free to contact the team members or test maintainers. From e999b921024a3fa963a76cc098f1e0e4b940824b Mon Sep 17 00:00:00 2001 From: Abel Mesfin Teka Date: Fri, 3 Jan 2025 19:29:07 +0300 Subject: [PATCH 2/3] inline html removed --- solutions/tests/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/solutions/tests/README.md b/solutions/tests/README.md index b988dc033..1719d0e91 100644 --- a/solutions/tests/README.md +++ b/solutions/tests/README.md @@ -17,14 +17,14 @@ The tests are designed to: ## Writing Tests -- Use consistent naming conventions for test files (e.g., `test_.py`). +- 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. ## Running Tests 1. Navigate to this directory in your terminal. -2. Use the designated command for the testing framework (e.g., `pytest`, `npm test`, etc.). +2. Use the designated command for the testing framework 3. Ensure all tests pass before pushing changes. ## Contribution Guidelines From 00240452e4f7517a92e55290dc876538b59d4a75 Mon Sep 17 00:00:00 2001 From: Abel Mesfin Teka Date: Fri, 3 Jan 2025 23:53:18 +0300 Subject: [PATCH 3/3] allowing inline html. --- .markdownlint.yml | 1 + solutions/README.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.markdownlint.yml b/.markdownlint.yml index 52b9d5266..751ec19c7 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -37,3 +37,4 @@ MD048: # Code block style (consistent backticks) # Disable some strict rules for beginners MD024: false # Allow multiple headings with the same content MD041: false # First line in a file being a top-level heading +MD033: false # allow inline html diff --git a/solutions/README.md b/solutions/README.md index f30bf42dc..40b1b141d 100644 --- a/solutions/README.md +++ b/solutions/README.md @@ -1,6 +1,6 @@ # Solutions -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 the group. +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. ## Directory Structure