Skip to content

docs: Fix typos in readme #702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ayushshukla1807 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Fix typos in readme #702

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions simplq/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ 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.

We've also set up **Sentry** to monitor the status of the website and to quickly tackle new issues.

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.