From 3fab6294694ae341b48342460d79372f92f1a0d9 Mon Sep 17 00:00:00 2001 From: Prayag Das Date: Wed, 26 Jun 2024 18:18:44 -0700 Subject: [PATCH] Fixed more Codacy issues. --- ui/__mocks__/README.md | 8 +++----- ui/cypress/README.md | 7 +++---- ui/public/README.md | 3 +-- ui/src/access/README.md | 4 ++-- ui/src/app/README.md | 4 +--- ui/src/components_/README.md | 6 +++--- ui/src/hooks/README.md | 6 ++---- ui/tests/README.md | 4 ++-- 8 files changed, 17 insertions(+), 25 deletions(-) diff --git a/ui/__mocks__/README.md b/ui/__mocks__/README.md index e233432..2b815c7 100644 --- a/ui/__mocks__/README.md +++ b/ui/__mocks__/README.md @@ -1,6 +1,4 @@ -# Mocks - -## What's in here? +# What's in here? In the mocks folder, we store mocks, which are simulated objects or functions @@ -13,7 +11,7 @@ and predictable environments for testing, making it easier to identify and fix issues. -## Purpose of Mocks +# Purpose of Mocks - Isolation: Mocks isolate the unit of code being tested from its dependencies, @@ -29,7 +27,7 @@ network requests or database queries. the setup and teardown of complex systems, making tests easier to write and maintain. -## Additional Resources +# Additional Resources You can find more information about Jest manual mocks here: diff --git a/ui/cypress/README.md b/ui/cypress/README.md index 1b9acc8..f1726f3 100644 --- a/ui/cypress/README.md +++ b/ui/cypress/README.md @@ -1,6 +1,5 @@ -# Cypress +# What's in here? -## What's in here? In the 'cypress' folder, we keep tests that use Cypress, an open-source end-to-end testing framework for web applications. @@ -9,7 +8,7 @@ providing a robust and easy-to-use tool for writing, running, and debugging tests for modern web applications. -## Cypress Features +# Cypress Features - End-to-End Testing: Cypress allows you to test the entire application @@ -63,7 +62,7 @@ a rich ecosystem of plugins and extensions, allowing you to extend its functionality to suit your testing needs. -## Additional Resources +# Additional Resources You can find more information on the official Cypress documentation here: diff --git a/ui/public/README.md b/ui/public/README.md index b7bc670..7fef769 100644 --- a/ui/public/README.md +++ b/ui/public/README.md @@ -1,6 +1,5 @@ -# Public +# What's in here? -## What's in here? In the 'public' folder, we store items that we use commonly for easy access. In the data sub-folder, we have data diff --git a/ui/src/access/README.md b/ui/src/access/README.md index 759b3e7..8c14b12 100644 --- a/ui/src/access/README.md +++ b/ui/src/access/README.md @@ -1,6 +1,6 @@ # Access -## What's in here? +# What's in here? The access folder typically contains modules related to managing and controlling @@ -9,7 +9,7 @@ This folder often includes files for handling authorization, roles, sessions, and other security-related concerns. -## Purpose of the Access folder +# Purpose of the Access folder The purpose of the access folder is to centralize and organize all logic related diff --git a/ui/src/app/README.md b/ui/src/app/README.md index f963382..16e5516 100644 --- a/ui/src/app/README.md +++ b/ui/src/app/README.md @@ -1,6 +1,4 @@ -# App - -## What's in here? +# What's in here? The 'app' directory houses the application's pages and their corresponding components. diff --git a/ui/src/components_/README.md b/ui/src/components_/README.md index 588eba7..9909442 100644 --- a/ui/src/components_/README.md +++ b/ui/src/components_/README.md @@ -1,6 +1,6 @@ # Components -## What's in here? +# What's in here? The 'components_' folder contains the building blocks of our pages. @@ -20,7 +20,7 @@ stored with their respective pages, and components with various usages, are kept in this folder. -## Atomic Components +# Atomic Components Atomic components do not contain any subcomponents. @@ -29,7 +29,7 @@ use will consist of atomic components that are both imported and written by us. -## Additional Resources +# Additional Resources Codevolution has a wonderful video with specifics on how diff --git a/ui/src/hooks/README.md b/ui/src/hooks/README.md index 4942070..d829d60 100644 --- a/ui/src/hooks/README.md +++ b/ui/src/hooks/README.md @@ -1,6 +1,4 @@ -# Hooks - -## What's in here? +# What's in here? In the 'hooks' folder, we store custom React hooks, which are @@ -11,7 +9,7 @@ to use these features in functional components, making it easier to manage and reuse component logic. -## Additional Resources +# Additional Resources React Docs on hooks: diff --git a/ui/tests/README.md b/ui/tests/README.md index b9e4099..bffaa20 100644 --- a/ui/tests/README.md +++ b/ui/tests/README.md @@ -1,6 +1,6 @@ # Tests -## What's in here? +# What's in here? In the 'tests' folder, we store test classes for our app's various @@ -13,7 +13,7 @@ They help ensure that changes to the codebase do not introduce new bugs or issues. -## Additional Resources +# Additional Resources We primarily use JEST, a Javascript testing framework,