Skip to content

Commit 4d6e516

Browse files
committed
Updated contributing guide
1 parent 9ef1be7 commit 4d6e516

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

Diff for: CONTRIBUTING.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,27 @@
11
# Contributing Guide
2+
3+
## General
24
1. Make sure you have read and understand the **Goals** section to be aligned with project goals.
35
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).
97

10-
**Mandatory PR checklist**:
8+
## PR Checklist
119
- generate a new `README.md` from `README_SOURCE.md` using command:
1210
```
1311
sh ./generate-readme.sh
1412
1513
# or if you don't like bash, simply use node.js
1614
# node ./generate-readme.js
1715
```
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
21+
22+
**Source code examples inject directives:**
23+
```
24+
::example='playground/src/components/sfc-counter.tsx'::
25+
26+
::usage='playground/src/components/sfc-counter.usage.tsx'::
27+
```

0 commit comments

Comments
 (0)