@nycplanning/streetscape 0.8.2 → 0.10.0

package/README.md

@@ -1,4 +1,4 @@
-# Design System
+# Streetscape
 
 This repo contains the primary implementation of Streetscape, NYC Planning Digital's design system. It contains code to run and publish a website with [Storybook](https://storybook.js.org/), as well as an NPM package.
 
@@ -8,4 +8,8 @@ Once you've cloned the repo, `cd` into it and install dependencies by running `n
 
 > Internally, we use [nvm](https://github.com/nvm-sh/nvm) to manage versions of Node.js. The `.nvmrc` file in this repo tells you which version of Node you should be using when working on it. If you are using `nvm`, you can have it switch automatically by running `nvm use` from the root of this repository.
 
-Then, to run the Storybook site locally, simply run `npm run dev`.
+Then, to run the Storybook site locally, simply run `npm run dev`.
+
+### Creating Conventional Commits
+
+For any new commits to be merged into `main` of this repo, we require that those commits conform to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard. Please review that documentation to understand the basic components of Conventional Commits. This repo comes packaged with `devDependencies` to make creating Conventional Commits easy. Specifically, we use tools from [Commitlint](https://commitlint.js.org/#/) and [Commitizen](https://github.com/commitizen) projects. When you have staged changes and are ready to create a commit, simply run `npm run commit` and the interactive CLI will walk you through creating a Conventional Commit. Note that we do not have a git hook configured in this project to require Conventional Commits in contributors' local environments. This is to allow developers to create non-conventional commits locally for the purposes of tracking their work incrementally. However, contributors who work in that way will be required make all commits in a PR match the Conventional Commit standard before their PR will be reviewed, either through squashing or otherwise updating their commit messages.

package/dist/components/Button/index.d.ts

@@ -1,2 +1,6 @@
 export { Button } from "./Button";
+export { IconButton } from "./IconButton";
+export { ButtonGroup } from "./ButtonGroup";
 export type { ButtonProps } from "./Button";
+export type { IconButtonProps } from "./IconButton";
+export type { ButtonGroupProps } from "./ButtonGroup";

package/dist/components/CloseButton/index.d.ts

@@ -0,0 +1 @@
+export * from "./CloseButton";

package/dist/components/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./Accordion";
 export * from "./Button";
+export * from "./CloseButton";
 export * from "./Checkbox";
 export * from "./Switch";
 export * from "./Input";