You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1. Make sure you have read and understand the **Goals** section to be aligned with project goals.
3
5
2. Before submitting a PR please comment in the relevant issue (or create a new one if it doesn't exist yet) to discuss all the requirements (this will prevent rejecting the PR and wasting your work).
4
-
3. All workflow scripts (prettier, linter, tests) must pass successfully.
5
-
4. Don't edit `README.md` directly - it is built using generator from `README_SOURCE.md`.
6
-
- Use `sh ./generate-readme.sh` script to generate `README.md` (this will inject code examples using type-checked source files from the `/playground` folder)
7
-
- include directives look like this: `::[example|usage]='playground/src/components/sfc-counter.tsx'::`
8
-
- To make changes in code examples edit source files in `/playground` folder
6
+
3. All workflow scripts (prettier, linter, tests) must pass successfully (it is run automatically on CI and will fail on github checks).
9
7
10
-
**Mandatory PR checklist**:
8
+
##PR Checklist
11
9
- generate a new `README.md` from `README_SOURCE.md` using command:
12
10
```
13
11
sh ./generate-readme.sh
14
12
15
13
# or if you don't like bash, simply use node.js
16
14
# node ./generate-readme.js
17
15
```
16
+
17
+
## `README.md` and `README_SOURCE.md`
18
+
Don't edit `README.md` directly - it is generated automatically from `README_SOURCE.md` using script.
19
+
- Use `sh ./generate-readme.sh` script to generate updated `README.md` (this will inject code examples using type-checked source files from the `/playground` folder)
20
+
- So to make changes in code examples edit source files in `/playground` folder
0 commit comments