@@ -36,15 +36,17 @@ Discussing the design up front helps to ensure that we're ready to accept your w
36
36
37
37
### ▶ 3. Fork this repo and create a branch.
38
38
39
- - Hit that "Fork" button above (in this repo's github page).
39
+ - Hit that "Fork" button above (in this repo's GitHub page).
40
40
41
41
![ image] ( https://user-images.githubusercontent.com/1430726/95460679-ec014400-097d-11eb-9a7a-93e0262d37d9.png )
42
42
43
43
- git clone your fork
44
44
45
- ` git clone YOUR_FORK_URL `
45
+ ``` shell
46
+ git clone YOUR_FORK_URL
47
+ ```
46
48
47
- Get your url by from here 👇
49
+ Get your URL by from here 👇
48
50
49
51
![ image] ( https://user-images.githubusercontent.com/1430726/95461173-94afa380-097e-11eb-9568-dc986e050de6.png )
50
52
@@ -58,17 +60,29 @@ git checkout -b my-fix-branch main
58
60
59
61
### ▶ 4. Run the library
60
62
61
- - From the root of the project run ` pnpm install ` .
63
+ - From the root of the project run the following command:
64
+
65
+ ``` shell
66
+ pnpm install
67
+ ```
68
+
69
+ - Then run this command:
62
70
63
- - Then run ` npx nx@latest serve website ` .
71
+ ``` shell
72
+ npx nx@latest serve website
73
+ ```
64
74
65
75
- Visit the URL printed in the console and you'll have a page opened with the suite of widgets.
66
76
67
77
- Once you made some changes in either package (` headless ` , ` tailwind ` or ` material ` ), you will see them immediately reflected on the page.
68
78
69
79
### ▶ 5. Make sure you add / modify tests
70
80
71
- Run ` pnpm run test ` to make sure there aren't any errors
81
+ Run the following command to make sure there aren't any errors:
82
+
83
+ ``` shell
84
+ pnpm run test
85
+ ```
72
86
73
87
<br />
74
88
@@ -88,7 +102,6 @@ This will create a descriptive commit message that follows the
88
102
This is necessary to generate meaningful release notes / CHANGELOG automatically.
89
103
90
104
<br />
91
-
92
105
### ▶ 7. Push your branch to GitHub:
93
106
94
107
``` shell
@@ -107,7 +120,11 @@ If you need to update your PR for some reason -
107
120
108
121
- Make the required updates.
109
122
110
- - Re-run the tests to ensure tests are still passing ` pnpm run test `
123
+ - Re-run the tests to ensure tests are still passing:
124
+
125
+ ``` shell
126
+ pnpm run test
127
+ ```
111
128
112
129
- Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
113
130
0 commit comments