Skip to content

Commit bd580e0

Browse files
committed
Add development setup to demo
1 parent 48c78a4 commit bd580e0

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

packages/react-renderer-demo/src/common/documenation-pages.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ export const docs = [{
55
link: '/live-editor',
66
label: 'Live Form Editor',
77
},
8+
}, {
9+
component: 'development-setup',
10+
linkText: 'Development setup',
811
}, {
912
component: 'get-started',
1013
linkText: 'Getting started',
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
### Development setup
2+
3+
Data Driven Forms is a monorepo which uses [Lerna](https://github.com/lerna/lerna), so you can use all its commands as well.
4+
5+
#### Install
6+
7+
```console
8+
yarn install
9+
```
10+
11+
#### Build
12+
13+
```console
14+
yarn build
15+
```
16+
17+
All packages are linked together by default, so if you run a `yarn build` in a package, all other packages are updated to the latest version of that package.
18+
19+
Don't forget to build all packages, which are linked together!
20+
21+
#### Run a package
22+
23+
Each package has a small playground `package/demo`, where you can test your changes.
24+
25+
```console
26+
cd packages/pf3-component-mapper
27+
yarn start
28+
```
29+
30+
#### How to clean?
31+
32+
```console
33+
rm yarn.lock
34+
yarn lerna clean # will delete all node_modules
35+
```
36+
37+
### Tests
38+
39+
Tests needed to be run from the core folder.
40+
41+
```console
42+
yarn test
43+
44+
yarn test packages/pf3-component-mapper
45+
```
46+
47+
### Commits
48+
49+
Data Driven Forms uses [Semantic Release](https://github.com/semantic-release/commit-analyzer)
50+
51+
Format:
52+
53+
```
54+
[type]([package]): message
55+
56+
fix(pf3): title accepts node
57+
```
58+
59+
Types:
60+
- `feat`: a new feature, will trigger new `_.X._` release
61+
- `fix`: a fix, will trigger new `_._.X` release
62+
63+
Packages:
64+
- Please describe which package is being changed `pf3`, `renderer`, ...
65+
66+
Please, do not use Semantic Release, if you update only the demo.
67+
68+
All packages are releasing together and they share the version number.
69+
70+
### Changes to documentation
71+
72+
If your changes influence API or add new features, you should describe these new options in the `demo` repository. Thanks!

0 commit comments

Comments
 (0)