Skip to content

Commit a1433cd

Browse files
committed
docs: updated readme and contributing.md to have make commands
Signed-off-by: shinigami-777 <chattopadhyaytamaghna@gmail.com>
1 parent 25711b8 commit a1433cd

2 files changed

Lines changed: 27 additions & 14 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,12 @@ make docker
121121

122122
Layer5 uses ES-Lint to maintain code quality & consistency in our UI Code.
123123

124+
Run the following command before commiting the changes:
125+
126+
```
127+
make lint
128+
```
129+
124130
# <a name="maintaining"> Reviews</a>
125131

126132
All contributors are invited to review pull requests. See this short video on [how to review a pull request](https://www.youtube.com/watch?v=isLfo7jfE6g&feature=youtu.be).

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,37 +37,44 @@ Make sure you have `npm` on `node@16` and above. The CI workflows checks for in
3737

3838
To set up the project, run the following command to install dependencies:
3939

40-
Please note that at this time, `npm install` will also build the project as the first step. This is to ensure that this is building correctly before moving to a task.
41-
4240
```
43-
setup:
44-
npm install
41+
make setup
4542
```
4643

4744
To check if your code meets the formatting standards, you can run:
4845

4946
```
50-
format-check:
51-
npm run format:check
47+
make format-check
48+
```
49+
50+
To automatically fix formatting issues, you can run:
51+
52+
```
53+
make format-fix
5254
```
5355

54-
To automatically fix formatting issues, you can run
56+
To test the sistent component locally, you can run:
5557

5658
```
57-
format-fix:
58-
npm run format:write
59+
make build
5960
```
6061

61-
To test the sistent component locally, you can run
62+
If you wish to build in watch mode:
6263

6364
```
64-
build:
65-
npm run build
65+
make build-watch
6666
```
6767

68+
To run Eslint:
69+
70+
```
71+
make lint
72+
```
73+
74+
To attach sistent to your project use:
75+
6876
```
69-
attach sistent to your project:
70-
npm install <path-to-sistent-on-local-machine>
77+
npm install <path-to-sistent-on-local-machine>
7178
```
7279

7380
> [!NOTE]

0 commit comments

Comments
 (0)