Skip to content

Commit ec5af06

Browse files
authored
refactor(contributing.md): made all code-commands into shell snippets (#478)
1 parent 3494212 commit ec5af06

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,17 @@ Discussing the design up front helps to ensure that we're ready to accept your w
3636

3737
### ▶ 3. Fork this repo and create a branch.
3838

39-
- Hit that "Fork" button above (in this repo's github page).
39+
- Hit that "Fork" button above (in this repo's GitHub page).
4040

4141
![image](https://user-images.githubusercontent.com/1430726/95460679-ec014400-097d-11eb-9a7a-93e0262d37d9.png)
4242

4343
- git clone your fork
4444

45-
`git clone YOUR_FORK_URL`
45+
```shell
46+
git clone YOUR_FORK_URL
47+
```
4648

47-
Get your url by from here 👇
49+
Get your URL by from here 👇
4850

4951
![image](https://user-images.githubusercontent.com/1430726/95461173-94afa380-097e-11eb-9568-dc986e050de6.png)
5052

@@ -58,17 +60,29 @@ git checkout -b my-fix-branch main
5860

5961
### ▶ 4. Run the library
6062

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:
6270

63-
- Then run `npx nx@latest serve website`.
71+
```shell
72+
npx nx@latest serve website
73+
```
6474

6575
- Visit the URL printed in the console and you'll have a page opened with the suite of widgets.
6676

6777
- Once you made some changes in either package (`headless`, `tailwind` or `material`), you will see them immediately reflected on the page.
6878

6979
### ▶ 5. Make sure you add / modify tests
7080

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+
```
7286

7387
<br/>
7488

@@ -88,7 +102,6 @@ This will create a descriptive commit message that follows the
88102
This is necessary to generate meaningful release notes / CHANGELOG automatically.
89103

90104
<br/>
91-
92105
### ▶ 7. Push your branch to GitHub:
93106

94107
```shell
@@ -107,7 +120,11 @@ If you need to update your PR for some reason -
107120

108121
- Make the required updates.
109122

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+
```
111128

112129
- Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
113130

cla-signs/v1/cla.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,4 +377,4 @@
377377
"pullRequestNo": 478
378378
}
379379
]
380-
}
380+
}

0 commit comments

Comments
 (0)