Skip to content

Commit

Permalink
Remove the code block because Github can detect the File Structure
Browse files Browse the repository at this point in the history
  • Loading branch information
sherlyfebrianti96 committed Oct 15, 2022
1 parent 0eac498 commit 77ec38f
Showing 1 changed file with 97 additions and 99 deletions.
196 changes: 97 additions & 99 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,105 +178,103 @@ This is all about the files and the clear definition of their usage :

The file structures in this repository should look like this :

```markdown
Mocked-API
│ README.md
│ package.json
│ ...
└───middleware
│ │
│ └───rate-limiter
│ │ rate-limiter.ts
│ │
│ └───models
│ │
│ └───rate-limiter-response.ts
└───modules
│ │
│ └───feature-sample-1
│ │ │ feature-sample-1.routes.ts
│ │ │
│ │ └───data
│ │ │ │ data-1.ts
│ │ │ │ data-2.ts
│ │ │ │ ...
│ │ │
│ │ └───models
│ │ │ │ address.types.ts
│ │ │ │ country.types.ts
│ │ │ │ ...
│ │ │
│ │ └───utils
│ │ │ │ util-1.ts
│ │ │ │ util-2.ts
│ │ │ │ ...
│ │ │
│ │ └───tests /* Should have the same structure with `feature-sample-1` folder */
│ │ │ feature-sample-1.test.ts /* Test for `feature-sample-1.routes.ts` */
│ │ │
│ │ └───utils
│ │ │ util-1.test.ts
│ │ │ util-2.test.ts
│ │ │ ...
│ │
│ └───feature-sample-2
│ │ │ *.routes.ts
│ │ │
│ │ └───data
│ │ │ │
│ │ │ └─── *.ts
│ │ │
│ │ └───models
│ │ │ │
│ │ │ └─── *.types.ts
│ │ │
│ │ └───utils
│ │ │ │
│ │ │ └─── *.ts
│ │ │
│ │ └───tests /* Should have the same structure with `feature-sample-2` folder */
│ │ │ *.test.ts
│ │ │
│ │ └───utils
│ │ │
│ │ └─── *.ts
│ │
│ └───feature-sample-3
│ │ *.routes.ts
│ │
│ └───data
│ │ │
│ │ └─── *.ts
│ │
│ └───models
│ │ │
│ │ └─── *.types.ts
│ │
│ └───utils
│ │ │
│ │ └─── *.ts
│ │
│ └───tests /* Should have the same structure with `feature-sample-3` folder */
│ │ *.test.ts
│ │
│ └───utils
│ │
│ └─── *.ts
└───utils
│ │ file-utils-1.ts
│ │ file-utils-2.ts
│ │ ...
│ │
│ └───tests
│ │ file-utils-1.test.ts
│ │ file-utils-2.test.ts
│ │ ...
└───another-folders
```
Mocked-API
│ README.md
│ package.json
│ ...
└───middleware
│ │
│ └───rate-limiter
│ │ rate-limiter.ts
│ │
│ └───models
│ │
│ └───rate-limiter-response.ts
└───modules
│ │
│ └───feature-sample-1
│ │ │ feature-sample-1.routes.ts
│ │ │
│ │ └───data
│ │ │ │ data-1.ts
│ │ │ │ data-2.ts
│ │ │ │ ...
│ │ │
│ │ └───models
│ │ │ │ address.types.ts
│ │ │ │ country.types.ts
│ │ │ │ ...
│ │ │
│ │ └───utils
│ │ │ │ util-1.ts
│ │ │ │ util-2.ts
│ │ │ │ ...
│ │ │
│ │ └───tests /* Should have the same structure with `feature-sample-1` folder */
│ │ │ feature-sample-1.test.ts /* Test for `feature-sample-1.routes.ts` */
│ │ │
│ │ └───utils
│ │ │ util-1.test.ts
│ │ │ util-2.test.ts
│ │ │ ...
│ │
│ └───feature-sample-2
│ │ │ *.routes.ts
│ │ │
│ │ └───data
│ │ │ │
│ │ │ └─── *.ts
│ │ │
│ │ └───models
│ │ │ │
│ │ │ └─── *.types.ts
│ │ │
│ │ └───utils
│ │ │ │
│ │ │ └─── *.ts
│ │ │
│ │ └───tests /* Should have the same structure with `feature-sample-2` folder */
│ │ │ *.test.ts
│ │ │
│ │ └───utils
│ │ │
│ │ └─── *.ts
│ │
│ └───feature-sample-3
│ │ *.routes.ts
│ │
│ └───data
│ │ │
│ │ └─── *.ts
│ │
│ └───models
│ │ │
│ │ └─── *.types.ts
│ │
│ └───utils
│ │ │
│ │ └─── *.ts
│ │
│ └───tests /* Should have the same structure with `feature-sample-3` folder */
│ │ *.test.ts
│ │
│ └───utils
│ │
│ └─── *.ts
└───utils
│ │ file-utils-1.ts
│ │ file-utils-2.ts
│ │ ...
│ │
│ └───tests
│ │ file-utils-1.test.ts
│ │ file-utils-2.test.ts
│ │ ...
└───another-folders

### Commit Messages
<!-- TODO
Expand Down

0 comments on commit 77ec38f

Please sign in to comment.