From fb1656835eeec1606d427715bf032a55fc220265 Mon Sep 17 00:00:00 2001 From: AyushShukla1807 Date: Mon, 30 Mar 2026 22:25:12 +0530 Subject: [PATCH] docs: Fix typos in readme --- simplq/readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/simplq/readme.md b/simplq/readme.md index 65d93aa5..9a7071f8 100644 --- a/simplq/readme.md +++ b/simplq/readme.md @@ -10,7 +10,7 @@ Styles are defined as SCSS files and are imported into the respective React comp Since a lot of styles are reusable in our app, there is a file called **common.scss** which has many constants and mixins defined. Mixins provide a way to reuse css expressions. The idea followed here is that if a certain style needs to be reused more than once, define a mixin for it in **common.scss** and use it from there. The mixin names must be clear and concise. Try to define mixins only here since it will make it easier for people to check later on and will limit the need to import any file other than **common.scss**. -Other than common.scss, separate style modules are created for each reusable design element and each page of the app to strike a balance between not having too many files while also maintaing a clear separation of scope between the files present. +Other than common.scss, separate style modules are created for each reusable design element and each page of the app to strike a balance between not having too many files while also maintaining a clear separation of scope between the files present. For styling, the CSS classes should have names which are easily understandable and in the spirit of keeping things simple and maintainable, take care not to use obscure CSS snippets you find somewhere on the web and instead ask doubts on the issue page if you are really stuck somewhere so that we can discuss and find the best solution. Also note that we prefer to **use rem instead of px** for sizing whenever possible, so please keep that in mind. @@ -18,4 +18,4 @@ We've also set up **Sentry** to monitor the status of the website and to quickly The backend service is written in **Java** and is hosted on **AWS**. We connect to the backend APIs using **axios** and the code dealing with these services are stored in the **src/services** folder. All the non presentational business logic goes here. -Adding comments to describe parts of code that are hard to understand is encouraged. These comments could also be links to articles or stackoverflow answers that were used to solve any problems that occured. +Adding comments to describe parts of code that are hard to understand is encouraged. These comments could also be links to articles or stackoverflow answers that were used to solve any problems that occurred.