Skip to content

Commit 779625b

Browse files
add clean code cheat sheet
1 parent 1ea9e61 commit 779625b

File tree

8 files changed

+29
-2
lines changed

8 files changed

+29
-2
lines changed

docs/general/clean-code.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
id: clean-code
3+
title: Clean code cheat sheet
4+
---
5+
6+
import useBaseUrl from '@docusaurus/useBaseUrl';
7+
8+
#### [Original Source link](https://www.planetgeek.ch/wp-content/uploads/2014/11/Clean-Code-V2.4.pdf)
9+
<img alt="Docusaurus with Keytar" src={useBaseUrl('clean-code/page-1.png')} width = "2500px" />
10+
11+
<img alt="Docusaurus with Keytar" src={useBaseUrl('clean-code/page-2.png')} width = "2500px" />
12+
13+
<img alt="Docusaurus with Keytar" src={useBaseUrl('clean-code/page-3.png')} width = "2500px" />
14+
15+
<img alt="Docusaurus with Keytar" src={useBaseUrl('clean-code/page-4.png')} width = "2500px" />

docs/general-guidelines.md renamed to docs/general/general-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: general-guidelines
2+
id: guidelines
33
title: General Coding Standards
44
---
55

docs/javascript/files.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
id: files
3+
title: Files, Folders & Modules
4+
sidebar_label: Files, Folders & Modules
5+
---
6+
7+
#### The following convention should be followed for files, folders and package naming
8+
9+
* There are two strategies of naming files in JavaScript: **PascalCase** and **kebab-case**. In JavaScript frontend applications, you will often see PascalCase for naming components (e.g. React components).
10+
<!--Javasript-->
11+

sidebars.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ module.exports =
33
"docs": {
44
"Overview": [
55
"introduction",
6-
"general-guidelines"
6+
"general/guidelines",
7+
"general/clean-code"
78
],
89
"REST API": [
910
"rest-api/headers",

static/clean-code/page-1.png

1.4 MB
Loading

static/clean-code/page-2.png

1.19 MB
Loading

static/clean-code/page-3.png

1.37 MB
Loading

static/clean-code/page-4.png

803 KB
Loading

0 commit comments

Comments
 (0)