Skip to content

Commit 34798e4

Browse files
committed
Chore: simplify readme generation and enable ci-check
1 parent 86902ac commit 34798e4

25 files changed

+945
-2366
lines changed
File renamed without changes.

CONTRIBUTING.md

+10-14
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,16 @@
22
1. Make sure you have read and understand the **Goals** section to be aligned with project goals.
33
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).
44
3. All workflow scripts (prettier, linter, tests) must pass successfully.
5-
4. Don't edit `README.md` directly - it is built using `sh ./generate.sh` script to inject code snippets from the sources in the `/playground` folder (this will make sure all code examples are nicely formatted and working)
6-
- To make changes in `README.md` edit `.md` files that are located in the `/docs/markdown` folder
7-
- To make changes in code snippets edit source files in `/playground` folder
8-
- include directives look like this: `::[example|usage]='../../playground/src/components/sfc-counter.tsx'::`
9-
5. When submitting a PR please make sure that you run the following:
10-
```bash
11-
# run linter in `/playground` folder
12-
npm run lint
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
139

14-
# run type-checking in `/playground` folder
15-
npm run tsc
10+
**Mandatory PR checklist**:
11+
- generate a new `README.md` from `README_SOURCE.md` using command:
12+
```
13+
sh ./generate-readme.sh
1614
17-
# always re-generate `README.md` from root folder
18-
sh ./generate.sh
19-
# don't like bash scripts? simply use node.js script
20-
# node ./generator/bin/generate-readme.js
15+
# or if you don't like bash, simply use node.js
16+
# node ./generate-readme.js
2117
```

README.md

-1
Original file line numberDiff line numberDiff line change
@@ -1321,7 +1321,6 @@ window.localStorage = {
13211321
Object.values = () => [];
13221322
```
13231323
1324-
13251324
[⇧ back to top](#table-of-contents)
13261325
13271326
## Enzyme

0 commit comments

Comments
 (0)