Skip to content

Commit

Permalink
remove references to plop
Browse files Browse the repository at this point in the history
  • Loading branch information
HeartSquared committed Aug 4, 2023
1 parent 1ff8138 commit f3f777f
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 49 deletions.
24 changes: 1 addition & 23 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Kaizen utilises [Changesets](https://github.com/changesets/changesets) to outlin

Creating a changeset is straight forward:

1. Run `yarn changeset` (or `yarn commit`)
1. Run `yarn changeset`
2. Select the packages you have made changes to with spacebar, followed by enter
3. You will then be asked which packages should have a Major, Minor or Patch. So following [Semantic Versioning](#semantic-versioning), select the packages that apply and hit enter (you can also hit enter to skip)
4. Add a short [description](#description).
Expand All @@ -129,34 +129,12 @@ Note that since the `description` will be included in the CHANGELOG — and may

Note that in the case that a pull request touches files from more than one package, all of those packages will be released to the npm registry with the specified update. Sometimes this might be desirable (e.g. when performing a bulk update to package docs), but in general, **be on the lookout for pull requests which touch more than one package**, and break those changes up into separate pull requests!

## Canary releases

Canary releases create a way to test changes in production-like environments, and are a great way to reduce the risk of proposed changes to a package. Use canary releases when you're working on a significant refactor, experimenting with new technology, or making other large scale changes.

Any merged pull request into the (protected) `canary` branch will create a canary release, publishing a [pre-release version](https://semver.org/#spec-item-9) of any packages touched by that branch. Only repo admins are able to directly push to the `canary` branch without a pull request.

For example, opening a pull request to merge a branch containing `feat: Even more glitter` into the branch `canary` will release e.g. `@kaizen/[email protected]` to npm. This pre-release package version will then be available elsewhere for testing those changes prior to a full release.

:warning: **Note that canary releases should not be used in production.**

## Using new package releases

To use a newly released version of the Kaizen Component Library (or any other package) in a front-end codebase, run `yarn upgrade --latest <scoped package name>` (e.g. `yarn upgrade --latest @kaizen/component-library`).

Remember to always check the CHANGELOG (e.g. [`/packages/component-library/CHANGELOG.md`](./packages/component-library/CHANGELOG.md) or the [releases page](https://github.com/cultureamp/kaizen-design-system/releases)) for any package you wish to upgrade, paying extra attention to any breaking changes which have been introduced since the last version used in your project.

## Contributing components

To learn more about contributing components, see the [Kaizen Site: components overview](https://cultureamp.design/components/overview).

### Patterns

Refer to the [docs folder](docs) for code guidelines and patterns.

### Component generator

To generate a new component and package, new component within an existing package, or a subcomponent,
run the following command and follow the prompts:
```
yarn plop
```
13 changes: 0 additions & 13 deletions docs/basic-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

Recipe for creating a basic component.

- [Intro](#intro)
- [Component structure](#component-structure)
- [Subcomponents](#subcomponents)
- [Hooks and Utils](#hooks-and-utils)
Expand All @@ -15,18 +14,6 @@ Recipe for creating a basic component.
- [The component](#the-component)
- [Display name](#display-name)

## Intro

To generate a new component and package, new component within an existing package, or a subcomponent,
run the following command and follow the prompts:
```
yarn plop
```
or run the following command to answer the name prop (replace `NewComponentName` with your component name):
```
yarn plop NewComponentName
```

## Component structure

Given the component `PancakeStack`, the component structure will follow this:
Expand Down
13 changes: 0 additions & 13 deletions docs/package-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

Recipe for creating a new package.

- [Intro](#intro)
- [Package structure](#package-structure)
- [Documentation](#documentation)
- [Components](#components)
Expand All @@ -11,18 +10,6 @@ Recipe for creating a new package.
- [package.json](#packagejson)
- [tsconfig.dist.json](#tsconfigdistjson)

## Intro

To generate a new component and package, new component within an existing package, or a subcomponent,
run the following command and follow the prompts:
```
yarn plop
```
or run the following command to answer the name prop (replace `NewComponentName` with your component name):
```
yarn plop NewComponentName
```

## Package structure

Given the component `PancakeStack`, the package structure will follow this:
Expand Down

0 comments on commit f3f777f

Please sign in to comment.