Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit b437373

Browse files
Fixing style guide intro text
1 parent d443911 commit b437373

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,17 @@ If you have any questions or if something is not entirely clear ¯\\\_(ツ)\_/¯
3737

3838
## Before you start
3939

40-
In the following weeks we will be using a `styleguide` to help you write _"clean code"_. What is a styleguide? Simply put, it's a set of design standards put in one collection. Companies create and use them to define their public identity (their "brand"). Watch the following to get a better idea:
40+
In the following weeks we will be using a "style guide" to help you write _"clean code"_. Because code is not only meant to be run by computers, but also to be read by humans (your colleagues, and the future version of you), it's best to make your code good. If your code is readable and nicely formatted, you're doing your colleages (and future you) a great server. The idea of a "style guide" comes from visual design, where companies often have a "visual style". For example, watch the following video to get an idea of this:
4141

4242
- [Creating Your Company's Style Guide](https://www.youtube.com/watch?v=gv_wrrY70E0)
4343

44-
A styleguide is made by designers. In the case of website design, this styleguide is then handed over to developers to use when styling the frontend.
45-
46-
The styleguide we'll be using is the one from Airbnb:
44+
Similarl to how designers have style guides for their design work, programmers often have "programming style guides". This is set of rules to follow when writing/formatting your code. The styleguide we'll be using is the one from Airbnb:
4745

4846
- [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript)
4947

5048
While you do not need to read this guide in detail, it is recommended that you look at sections 1-8, 12-13, 15-21 and 23.
5149

52-
The required packages you need to install in order to write code according to the styleguide are the following:
50+
We also have tools that can automatically check whether your code is correctly formatted according to a style guide. These tools are called "linters". We will be using the JavaScript linter called "ESLint". The following packages are already added to this repository's `package.json`:
5351

5452
```json
5553
"eslint"
@@ -60,7 +58,7 @@ The required packages you need to install in order to write code according to th
6058
"prettier"
6159
```
6260

63-
They are already in this repository's `package.json` so all you have to do now to prepare is to execute the following command in your command line:
61+
All you have to do now to prepare is to execute the following command in your command line:
6462

6563
```md
6664
npm install

0 commit comments

Comments
 (0)