Skip to content

Commit e507b71

Browse files
committed
Added development setup from master.
1 parent 017cb2b commit e507b71

File tree

2 files changed

+88
-0
lines changed

2 files changed

+88
-0
lines changed
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
import Grid from '@material-ui/core/Grid'
2+
3+
import ListOfContents from '../../src/helpers/list-of-contents';
4+
5+
<Grid container item>
6+
<Grid item xs={12} md={10}>
7+
8+
### Development setup
9+
10+
Data Driven Forms is a monorepo which uses [Lerna](https://github.com/lerna/lerna), so you can use all its commands as well.
11+
12+
#### Install
13+
14+
```console
15+
yarn install
16+
```
17+
18+
#### Build
19+
20+
```console
21+
yarn build
22+
```
23+
24+
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.
25+
26+
Don't forget to build all packages, which are linked together!
27+
28+
#### Run a package
29+
30+
Each package has a small playground `package/demo`, where you can test your changes.
31+
32+
```console
33+
cd packages/pf3-component-mapper
34+
yarn start
35+
```
36+
37+
#### How to clean?
38+
39+
```console
40+
rm yarn.lock
41+
yarn lerna clean # will delete all node_modules
42+
```
43+
44+
### Tests
45+
46+
Tests needed to be run from the core folder.
47+
48+
```console
49+
yarn test
50+
51+
yarn test packages/pf3-component-mapper
52+
```
53+
54+
### Commits
55+
56+
Data Driven Forms uses [Semantic Release](https://github.com/semantic-release/commit-analyzer)
57+
58+
Format:
59+
60+
```
61+
[type]([package]): message
62+
63+
fix(pf3): title accepts node
64+
```
65+
66+
Types:
67+
- `feat`: a new feature, will trigger new `_.X._` release
68+
- `fix`: a fix, will trigger new `_._.X` release
69+
70+
Packages:
71+
- Please describe which package is being changed `pf3`, `renderer`, ...
72+
73+
Please, do not use Semantic Release, if you update only the demo.
74+
75+
All packages are releasing together and they share the version number.
76+
77+
### Changes to documentation
78+
79+
If your changes influence API or add new features, you should describe these new options in the `demo` repository. Thanks!
80+
81+
</Grid>
82+
<Grid item xs={false} md={2}>
83+
<ListOfContents file="renderer/development-setup" />
84+
</Grid>
85+
</Grid>

packages/react-renderer-demo/src/components/navigation/documentation-pages.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
export const docs = [{
22
component: 'installation',
33
linkText: 'Installation',
4+
}, {
5+
component: 'development-setup',
6+
linkText: 'Development Setup',
47
}, {
58
component: 'get-started',
69
linkText: 'Getting started',

0 commit comments

Comments
 (0)