You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Install Node.js](https://nodejs.org/en/download/package-manager) version 20 (or higher). Then install the project dependencies and build it by running:
198
+
199
+
```sh
200
+
yarn install
201
+
yarn build
199
202
```
200
203
201
-
3. Generate your component
204
+
3. Create a branch:
205
+
206
+
```sh
207
+
git checkout -b my-branch upstream/main
208
+
```
202
209
203
-
```bash
210
+
4. Generate your component
211
+
212
+
```sh
204
213
# Run the tool to Generate the component scaffolding
4. Develop your component. After development is complete, run build and ensure tests and lint standards pass.
226
+
5. Develop your component. After development is complete, run build and ensure tests and lint standards pass.
218
227
219
-
```text
220
-
$ yarn build
221
-
$ yarn test
228
+
```sh
229
+
yarn build
230
+
yarn test
222
231
```
223
232
224
233
Ensure no lint errors are introduced in `yarn-error.log` after running this command.
225
234
226
235
***Note to Windows users:*** you may need to change the path for the lint script in package.json to be `node_modules/eslint/bin/eslint`
227
236
228
-
5. Add a commit using `git commit`:
237
+
6. Add a commit using `git commit`:
229
238
230
239
This project uses [`lerna`](https://lernajs.io/) to do automatic releases and generate a changelog based on the commit history. So we follow [a convention][3] for commit messages. Please follow this convention for your commit messages.
231
240
232
-
6. Rebase
241
+
7. Rebase
233
242
234
243
Use `git rebase` (not `git merge`) to sync your work from time to time. Ensure all commits related to a single issue have been [squashed](https://github.com/ginatrapani/todo.txt-android/wiki/Squash-All-Commits-Related-to-a-Single-Issue-into-a-Single-Commit).
235
244
236
-
```text
237
-
$ git fetch upstream
238
-
$ git rebase upstream/main
245
+
```sh
246
+
git fetch upstream
247
+
git rebase upstream/main
239
248
```
240
249
241
-
7. Push
250
+
8. Push
242
251
243
-
```text
244
-
$ git push origin my-branch
252
+
```sh
253
+
git push origin my-branch
245
254
```
246
255
247
-
8. Create a pull request
256
+
9. Create a pull request
248
257
249
258
[Open a pull request](https://help.github.com/articles/using-pull-requests/) with a clear title and description against the `main` branch. Please be sure to include all of the following in your PR:
Copy file name to clipboardExpand all lines: packages/react-charts/README.md
+2-17
Original file line number
Diff line number
Diff line change
@@ -2,30 +2,15 @@
2
2
3
3
This package provides PatternFly charting components for [PatternFly][patternfly].
4
4
5
-
### Prerequisite
6
-
7
-
#### Node Environment
8
-
9
-
This project currently supports Node [Active LTS](https://github.com/nodejs/Release#release-schedule) releases. Please stay current with Node Active LTS when developing patternfly-react.
10
-
11
-
For example, to develop with Node 8, use the following:
12
-
13
-
```
14
-
nvm install 8
15
-
nvm use 8
16
-
```
17
-
18
-
This project also requires a Yarn version of >=1.6.0. The latest version can be installed [here](https://yarnpkg.com/).
Copy file name to clipboardExpand all lines: packages/react-code-editor/README.md
+4-19
Original file line number
Diff line number
Diff line change
@@ -2,42 +2,27 @@
2
2
3
3
This package provides a PatternFly wrapper for the Monaco code editor, using the `@monaco-editor/react` package.
4
4
5
-
### Prerequisite
6
-
7
-
#### Node Environment
8
-
9
-
This project currently supports Node [Active LTS](https://github.com/nodejs/Release#release-schedule) releases. Please stay current with Node Active LTS when developing patternfly-react.
10
-
11
-
For example, to develop with Node 18, use the following:
12
-
13
-
```
14
-
nvm install 18
15
-
nvm use 18
16
-
```
17
-
18
-
This project also requires a Yarn version of >=1.6.0. The latest version can be installed [here](https://yarnpkg.com/).
19
-
20
5
### Installing
21
6
22
-
```
7
+
```sh
23
8
yarn add @patternfly/react-code-editor
24
9
```
25
10
26
11
or
27
12
28
-
```
13
+
```sh
29
14
npm install @patternfly/react-code-editor
30
15
```
31
16
32
17
[!NOTE] For TypeScript type definitions, this package uses the `monaco-editor` package as a peer dependency. So, if you need types and don't already have the `monaco-editor package` installed, you will need to do so:
Copy file name to clipboardExpand all lines: packages/react-table/README.md
+2-17
Original file line number
Diff line number
Diff line change
@@ -2,30 +2,15 @@
2
2
3
3
This package provides Table PatternFly components based on [PatternFly][patternfly]
4
4
5
-
### Prerequisite
6
-
7
-
#### Node environment
8
-
9
-
This project currently supports Node [Active LTS](https://github.com/nodejs/Release#release-schedule) releases. Please stay current with Node Active LTS when developing patternfly-react.
10
-
11
-
For example, to develop with Node 18, use the following:
12
-
13
-
```
14
-
nvm install 18
15
-
nvm use 18
16
-
```
17
-
18
-
This project also requires a Yarn version of >=1.6.0. The latest version can be installed [here](https://yarnpkg.com/).
Copy file name to clipboardExpand all lines: packages/react-templates/README.md
+2-17
Original file line number
Diff line number
Diff line change
@@ -2,30 +2,15 @@
2
2
3
3
This package provides wrapped Patternfly component demos with a streamlined API for ease of use.
4
4
5
-
### Prerequisite
6
-
7
-
#### Node Environment
8
-
9
-
This project currently supports [Node Active LTS](https://github.com/nodejs/Release#release-schedule) releases. Please stay current with Node Active LTS when developing patternfly-react.
10
-
11
-
For example, to develop with Node 18, use the following:
12
-
13
-
```
14
-
nvm install 18
15
-
nvm use 18
16
-
```
17
-
18
-
This project also requires a Yarn version of >=1.6.0. The latest version can be installed from the [Yarn](https://yarnpkg.com/) home page.
0 commit comments