Skip to content
This repository was archived by the owner on Dec 1, 2025. It is now read-only.

Commit 97896dc

Browse files
committed
contributing docs updated and layout dependencies changed to peer-deps
1 parent 51dd226 commit 97896dc

4 files changed

Lines changed: 1461 additions & 2039 deletions

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ series [How to Contribute to an Open Source Project on GitHub][egghead]
1111
2. `npm yarn install` to setup and validate your clone of the project
1212
3. `npm yarn build` to lerna link dependencies
1313
4. Create a branch for your PR
14+
5. `yarn docz:dev` to start gatsby components site for components development
1415

1516
> Tip: Keep your `master` branch pointing at the original repository and make
1617
> pull requests from branches on your fork. To do this, run:
@@ -34,3 +35,19 @@ Please make sure to run the tests before you commit your changes. You can run
3435
3536
[issues]: https://github.com/thepensionsregulator/react-components/issues
3637
[egghead]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
38+
39+
## Deployment to NPM
40+
41+
Automatic deployment:
42+
43+
- Branch names that starts with `rc`, `feature` or `bug` will be automatically published to NPM with a `next` tag on a `patch` version, only if they pass build and tests on CircleCI. The status of deployment will be visible on a pull request.
44+
45+
Manual deployment:
46+
47+
- When you're ready to deploy `minor` or `major` versions you can do so from updated `develop` branch in your terminal running command `yarn deploy` and follow the instructions in your terminal. `Lerna` will bump all versions to chosen ones and will push git refs to github and new packages to npm registry.
48+
49+
## Deployment to Netlify
50+
51+
Automatic deployment:
52+
53+
- Create a PR to master branch and Netlify will build Gatsby site. If build is successful merge it and production site will be updated.

packages/layout/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ Layout components for TPR apps.
88
npm install @tpr/layout
99

1010
# Peer Dependencies - Also Required
11-
npm install react react-dom @tpr/theming
11+
npm install react react-dom @tpr/core @tpr/forms @tpr/icons @tpr/theming
1212
```

packages/layout/package.json

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@
3434
},
3535
"peerDependencies": {
3636
"react": "^16.12.0",
37-
"react-dom": "^16.12.0"
37+
"react-dom": "^16.12.0",
38+
"@tpr/core": "~2.1.7",
39+
"@tpr/forms": "~2.2.0",
40+
"@tpr/icons": "~2.1.7",
41+
"@tpr/theming": "~2.1.5"
3842
},
3943
"dependencies": {
40-
"@tpr/core": "file:../core",
41-
"@tpr/forms": "file:../forms",
42-
"@tpr/icons": "file:../icons",
43-
"@tpr/theming": "file:../theming",
4444
"@types/lodash": "^4.14.157",
4545
"@xstate/react": "^0.8.1",
4646
"date-fns": "^2.14.0",
@@ -52,7 +52,11 @@
5252
"xstate": "^4.10.0"
5353
},
5454
"devDependencies": {
55-
"cross-env": "^7.0.2"
55+
"cross-env": "^7.0.2",
56+
"@tpr/core": "file:../core",
57+
"@tpr/forms": "file:../forms",
58+
"@tpr/icons": "file:../icons",
59+
"@tpr/theming": "file:../theming"
5660
},
5761
"publishConfig": {
5862
"access": "public"

0 commit comments

Comments
 (0)