Skip to content

Commit 8e3b321

Browse files
authored
chore: improve CONTRIBUTING.md (#493)
* docs(contributing.md): added more useful commands to file This commit aims to improve the commands avaible to the reader. New commands offer more ways of consuming the repo while the old test commands have been replaced for commands that always produce the cypress GUI (if you ignore the --skip-nx-cache flag, you only get the cypress GUI the first time you run the command. Any time you run it afterwards you get a very meaningless message on the terminal). * docs(contributing.md): better readbility of sentence Replaces "docs" for "documentation" as the file calls it that everywhere else.
1 parent 3f6a0dd commit 8e3b321

File tree

1 file changed

+40
-8
lines changed

1 file changed

+40
-8
lines changed

CONTRIBUTING.md

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,31 +66,63 @@ git checkout -b my-fix-branch main
6666
pnpm install
6767
```
6868

69-
- Then run this command:
69+
- Download [Nx](https://nx.dev/):
7070

7171
```shell
72-
npx nx@latest serve website
72+
pnpm install --global nx@latest
73+
```
74+
75+
- Then run this command to get the qwik-ui documentation site in dev mode:
76+
77+
```shell
78+
pnpm website
7379
```
7480

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

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

85+
Below is a list of other commands that you might find useful:
86+
87+
- Build the qwik-ui documentation:
88+
89+
```shell
90+
nx build website
91+
```
92+
93+
- Preview of the qwik-ui documentation (no HMR):
94+
95+
```shell
96+
nx preview website
97+
```
98+
99+
- Build the Cloudfare version of the qwik-ui documentation
100+
101+
```shell
102+
nx build-cloudfare website
103+
```
104+
105+
- Preview the Cloudfare build of the qwik-ui documentation (no HMR)
106+
107+
```shell
108+
nx preview-cloudflare website
109+
```
110+
79111
### ▶ 5. Make sure you add / modify tests
80112

81-
Run either command to make sure there aren't any errors:
113+
Run either command to make sure there aren't any errors.
82114

83115
```shell
84-
nx component-test headless
116+
nx component-test headless --skip-nx-cache
85117
```
86118

87119
Or
88120

89121
```shell
90-
pnpm run test:headless
122+
pnpm run test:headless --skip-nx-cache
91123
```
92124

93-
Both commands run the same tests. You are free to choose which syntax you prefer.
125+
Both commands will set up the Cypress component testing GUI, so you are free to chose which syntax you prefer. Please refer to official Cypress [documentation](https://docs.cypress.io/guides/overview/why-cypress) for further assistance.
94126
<br/>
95127

96128
### ▶ 6. Commit your changes using commitizen:
@@ -130,13 +162,13 @@ If you need to update your PR for some reason -
130162
- Re-run the tests to ensure tests are still passing:
131163

132164
```shell
133-
nx component-test headless
165+
nx component-test headless --skip-nx-cache
134166
```
135167

136168
Or
137169

138170
```shell
139-
pnpm run test:headless
171+
pnpm run test:headless --skip-nx-cache
140172
```
141173

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

0 commit comments

Comments
 (0)