@pantheon-systems/pds-toolkit-react 1.0.0-dev.4 → 1.0.0-dev.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -61
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,64 +5,3 @@ React Toolkit for the Pantheon Design System
|
|
|
5
5
|
This toolkit provides assets for use within a React project and a Storybook instance to preview the components.
|
|
6
6
|
|
|
7
7
|
[Published Storybook](https://live-pds-toolkit-react.appa.pantheon.site/)
|
|
8
|
-
|
|
9
|
-
## Local Development Setup
|
|
10
|
-
|
|
11
|
-
**Prerequisites:** Node 18 and npm
|
|
12
|
-
|
|
13
|
-
1. `npm install` — Installs dependencies
|
|
14
|
-
2. `npm run develop` — Compiles styles, watches for changes, and starts the Storybook development server.
|
|
15
|
-
|
|
16
|
-
## Project Structure
|
|
17
|
-
|
|
18
|
-
Notable directories and files unique to this project.
|
|
19
|
-
|
|
20
|
-
### /src/components
|
|
21
|
-
|
|
22
|
-
Each component will have its own named directory here. All files specific to the component, test files, and stories file should be included in the directory.
|
|
23
|
-
|
|
24
|
-
To create a new component run `npm run generate:component` from the root of the project.
|
|
25
|
-
|
|
26
|
-
### /src/docs
|
|
27
|
-
|
|
28
|
-
Any doc pages that do not belong to a specific component.
|
|
29
|
-
|
|
30
|
-
### /src/foundations
|
|
31
|
-
|
|
32
|
-
Includes stylesheets for native HTML elements and other global styles. Styles from this section will be compiled into `pds-core.css`.
|
|
33
|
-
|
|
34
|
-
Any stories built in this section are for example purposes only and will not have shipped JavaScript components.
|
|
35
|
-
|
|
36
|
-
To create a new foundation story run `npm run generate:foundation` from the root of the project.
|
|
37
|
-
|
|
38
|
-
### /src/patterns
|
|
39
|
-
|
|
40
|
-
Patterns are reusable configurations of components and other foundational elements.
|
|
41
|
-
|
|
42
|
-
Any stories built in this section are for example purposes only and will not have shipped JavaScript components.
|
|
43
|
-
|
|
44
|
-
To create a new pattern story run `npm run generate:pattern` from the root of the project.
|
|
45
|
-
|
|
46
|
-
### /src/utilities
|
|
47
|
-
|
|
48
|
-
Utilities include functionality that is used to build components, pages, or other digital experiences in accordance with design system guidelines such as utility classes and functions. Styles from this section will be compiled into `pds-core.css`.
|
|
49
|
-
|
|
50
|
-
Any stories built in this section are for example purposes only and will not have shipped JavaScript components.
|
|
51
|
-
|
|
52
|
-
To create a new utility run `npm run generate:utility` from the root of the project.
|
|
53
|
-
|
|
54
|
-
## Contributing
|
|
55
|
-
|
|
56
|
-
### Updating a Component
|
|
57
|
-
|
|
58
|
-
When making changes to a component, be sure to also update any associated tests. (COMING SOON -- tests are not enabled at this time).
|
|
59
|
-
|
|
60
|
-
### Adding a new Component
|
|
61
|
-
|
|
62
|
-
Run `npm run generate:component` from the project root to scaffold files necessary for the component.
|
|
63
|
-
|
|
64
|
-
### Update the Changelog
|
|
65
|
-
|
|
66
|
-
Add any changes that will affect the consumer of the toolkit to the `Unreleased` section of `CHANGELOG.md`.
|
|
67
|
-
|
|
68
|
-
When creating a new release, update `CHANGELOG.md` accordingly with the new version number and start a new `Unreleased` section at the top.
|