Skip to content

Commit

Permalink
Update CONTRIBUTING.md πŸ”₯
Browse files Browse the repository at this point in the history
  • Loading branch information
mo1ein committed May 22, 2024
1 parent 21694fb commit e757d50
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
bin/
book/
todo.md
gh-md-toc

Expand Down
12 changes: 5 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@
# Contributing

First of all, thank you for reading here to contribute! I really appriciate that. <br />
Please do not modify files in the `book` directory as they are generated by `mdbook`. Make changes in the `src` directory instead.

## Share experience
If you want to share your interview experience, If the company exist in the `src`, just create a `md` file with company name in the `src`. If the company is not exist, create a directory with company name and put each experience on it.
Then for compile, you need to add your `md` file to `SUMMARY.md`.
If you want to share your interview experience, create a directory with company name (if not exist) and put your `md` file in it.
Then for compile, you need to add your `md` file path to `SUMMARY.md`.
Just like this:
```
src/snapp
β”œβ”€β”€ snapp_cab_1.md
β”œβ”€β”€ snapp_cab_2.md
β”œβ”€β”€ snapp_market_pro.md
└── snapp.md
└── snapp_cab_2.md
```
You can add your name (if you like) after the company name like: `snapp_moein.md` and that's good to write it in the file otherwise, write `unknown`.

## Install
You need to install mdbook. Just install binaries if you are not familiar with `rust` and `cargo`. <br />
Watch this [link](https://github.com/rust-lang/mdBook/releases) for releases.
Watch this [link](https://github.com/rust-lang/mdBook/releases) for releases. <br />
For mermaid charts, install [this](https://github.com/badboy/mdbook-mermaid).

## Build
For building after your changes in the root dir of project:
Expand Down

0 comments on commit e757d50

Please sign in to comment.