Skip to content

Commit

Permalink
Fixed more Codacy issues.
Browse files Browse the repository at this point in the history
  • Loading branch information
Prayag-Das committed Jun 27, 2024
1 parent 0d14630 commit 3fab629
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 25 deletions.
8 changes: 3 additions & 5 deletions ui/__mocks__/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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,
Expand All @@ -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:
Expand Down
7 changes: 3 additions & 4 deletions ui/cypress/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand Down
3 changes: 1 addition & 2 deletions ui/public/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions ui/src/access/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Access

## What's in here?
# What's in here?

The access folder typically contains
modules related to managing and controlling
Expand All @@ -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
Expand Down
4 changes: 1 addition & 3 deletions ui/src/app/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 3 additions & 3 deletions ui/src/components_/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Components

## What's in here?
# What's in here?

The 'components_' folder contains
the building blocks of our pages.
Expand All @@ -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.
Expand All @@ -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
Expand Down
6 changes: 2 additions & 4 deletions ui/src/hooks/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Hooks

## What's in here?
# What's in here?

In the 'hooks' folder, we store
custom React hooks, which are
Expand All @@ -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:
<https://legacy.reactjs.org/docs/hooks-intro.html>
Expand Down
4 changes: 2 additions & 2 deletions ui/tests/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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,
Expand Down

0 comments on commit 3fab629

Please sign in to comment.