Skip to content

Commit 4c8313a

Browse files
authored
chore: update docs and housekeeping (#1689)
1 parent e637b05 commit 4c8313a

17 files changed

+31
-1450
lines changed

.plop/actions/install-dependencies.js

Lines changed: 0 additions & 22 deletions
This file was deleted.

.plop/templates/component/README.md.hbs

Lines changed: 0 additions & 14 deletions
This file was deleted.

.plop/templates/component/component.tsx.hbs

Lines changed: 0 additions & 20 deletions
This file was deleted.

.plop/templates/component/package.json.hbs

Lines changed: 0 additions & 51 deletions
This file was deleted.

.plop/templates/component/spec.tsx.hbs

Lines changed: 0 additions & 11 deletions
This file was deleted.

.plop/templates/component/src-index.ts.hbs

Lines changed: 0 additions & 2 deletions
This file was deleted.

.plop/templates/component/story.tsx.hbs

Lines changed: 0 additions & 18 deletions
This file was deleted.

.plop/templates/component/styles.css.hbs

Lines changed: 0 additions & 3 deletions
This file was deleted.

.plop/templates/component/tsconfig.build.json.hbs

Lines changed: 0 additions & 7 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,10 @@ Note: if you are creating a pull request from a fork, CI checks will only run wh
132132
$ pnpm chromatic --project-token PROJECT_TOKEN --branch-name FORKED_BRANCH --build-script-name storybook:build --exit-once-uploaded --only-changed --externals "packages/icons/src/img/**" --externals "packages/tokens/tokens/**"
133133
```
134134

135+
### Step 6: Test and verify your changes
136+
137+
If you updated the `components`, `icons`, or `tokens` package your PR will be decorated with preview releases ([example](https://github.com/launchdarkly/launchpad-ui/pull/1686#issuecomment-2898653450)) which will allow you to install them to your project to test/verify. This is helpful for bug fixes or ensuring no regressions result from a refactoring and/or style changes.
138+
135139
---
136140

137141
## Common Tasks
@@ -170,12 +174,6 @@ The following command will run unit tests in every package of the monorepo:
170174
$ pnpm test
171175
```
172176

173-
### Generating New Packages With Plop
174-
175-
With the help of [plop](https://plopjs.com), we can quickly scaffold new component files in a consistent and opinionated way.
176-
177-
Simply run `pnpm generate component` and follow the prompts, and you'll be well on your way to adding a new component package to LaunchPad.
178-
179177
### Adding Dependencies to Packages
180178

181179
- Pin dependencies.
@@ -212,6 +210,6 @@ All CSS code is linted with [Biome](https://biomejs.dev/).
212210

213211
### Specs Styleguide
214212

215-
- Include thoughtfully-worded, well-structured [Vitest](https://vitest.dev/) specs in the `__test__` folder of each package.
213+
- Include thoughtfully-worded, well-structured [Vitest](https://vitest.dev/) specs in the `__tests__` folder of each package.
216214
- Treat `describe` as a noun or situation.
217215
- Treat `it` as a statement about state or how an operation changes state.

0 commit comments

Comments
 (0)