7.0.6 • Published 3 years ago

@teachers/design-system v7.0.6

Weekly downloads
1,277
License
UNLICENSED
Repository
github
Last release
3 years ago

design-system

Your one-stop shop for TeachersPayTeachers design system bits.

install

# install proper Node.js version
asdf install

# install dependencies
yarn

run

# start Storybook for development
yarn dev

tests

# run tests
yarn test

# run linting
yarn lint

# run linting for scripts only
yarn lint:scripts

# run linting for styles only
yarn lint:style

build

# cleans previous builds and build scripts and design tokens
# output goes to dist/ directory
yarn build

# build scripts only
yarn build:scripts

# build design tokens only
yarn build:design-tokens

# clean build
yarn clean

publish

Package publishing is currently manual and is done from the CLI. Automated CI publishing to come soon.

# push tags to Github repo
git push --follow-tags origin master

# publish to npm
npm publish --tag <tag to publish, e.g. 0.0.1>

contributing

release process

We use semantic versioning and a variation of conventional commits to version releases.

Here is a brief overview of the process:

  1. Fork branch off master, e.g. my-feature. Commit desired changes (does not have to be in conventional commits format, but it is encouraged)
  2. Open PR for my-feature branch.
  3. Wait for tests and checks to run.
  4. Title your PR according to the conventional commits convention.
    • The Semantic Pull Request check will check that your PR title.
    • If it does not pass, the check will remain in pending (yellow mode)
    • Update accordingly and the check will automatically re-run.
    • The PR title will be the commit message when squashed to master.
  5. Squash and merge to master
    • We only allow squash and merge. This keeps the commit history clean and easy to parse.
    • Each PR = one feature/fix/breaking change
  6. TODO standard-version will run in CI to generate CHANGELOG and version bump and publish to NPM

Note: If there is a BREAKING CHANGE, the phrase can and should appear anywhere in the commit history (not just PR title) for it to be picked up for versioning

conventional commits

Our convention is a subset of the conventional commits standard. Please read the following as it may be different from projects you have worked on in the past.

Each squashed PR commit message consists of a header and a body. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

types

We follow Angular-style commit types as follows:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

scope

The scope of the commit should be a reference to a JIRA ticket, e.g. WEB-2184. This scope will appear in the CHANGELOG and will make it easy for us to track features in the CHANGELOG. This is not currently enforced in checks, but will be appreciated.

breaking changes

A commit that has the text BREAKING CHANGE: at the beginning of its optional body section introduces a breaking API change (correlating with MAJOR in semantic versioning). A BREAKING CHANGE can be part of commits of any type. It does not have to be part of the PR title.

examples

feat(WEB-2424): add Text and Heading components
fix(WEB-2346): fix bug where Tooltip was not rendering on hover
fix(WEB-1234): add missing prop for component
refactor: rename ComponentX to ComponentY
docs: update README with contribution guidelines

questions

Please contact #web-platform on Slack!

@babel/clibootstrapcopyfilesfocus-visiblemerge-propsreact-bootstrapreact-iconsreact-innertextsass-rem
7.0.6

3 years ago

7.0.5

3 years ago

6.5.0-dev.2

3 years ago

6.5.0

3 years ago

6.5.0-dev

3 years ago

7.0.4

3 years ago

6.4.0-dev.4

3 years ago

6.4.0-dev.3

3 years ago

6.4.0-dev.2

3 years ago

6.4.0

3 years ago

7.0.3

3 years ago

6.4.0-dev.1

3 years ago

7.0.2

3 years ago

7.0.1

3 years ago

7.0.0

3 years ago

7.0.0-dev.13

3 years ago

7.0.0-dev.15

3 years ago

7.0.0-dev.14

3 years ago

7.0.0-dev.11

3 years ago

7.0.0-dev.10

3 years ago

7.0.0-dev.12

3 years ago

6.3.1

3 years ago

7.0.0-dev.9

3 years ago

7.0.0-dev.8

3 years ago

7.0.0-dev.6

3 years ago

7.0.0-dev.7

3 years ago

7.0.0-dev.5

3 years ago

7.0.0-dev.3

3 years ago

7.0.0-dev.4

3 years ago

7.0.0-dev.2

3 years ago

7.0.0-dev.1

3 years ago

6.3.0

3 years ago

6.2.0

3 years ago

6.1.0

3 years ago

6.0.2

4 years ago

6.0.2-dev.1

4 years ago

6.0.1

4 years ago

6.0.0

4 years ago

6.0.0-dev.5

4 years ago

5.1.3

4 years ago

6.0.0-dev.4

4 years ago

6.0.0-dev.3

4 years ago

5.1.2-docsfix.1

4 years ago

6.0.0-dev.2

4 years ago

6.0.0-dev.1

4 years ago

5.1.2

4 years ago

5.1.1

4 years ago

5.1.1-dev.2

4 years ago

5.1.1-dev.1

4 years ago

5.1.0

4 years ago

5.0.1

4 years ago

5.0.0

4 years ago

4.3.0-pagination.12

4 years ago

4.2.0

4 years ago

4.2.0-pagination.11

4 years ago

4.2.0-pagination.10

4 years ago

4.1.3

4 years ago

4.1.2

4 years ago

4.2.0-pagination.8

4 years ago

4.2.0-pagination.9

4 years ago

4.2.0-pagination.7

4 years ago

4.2.0-pagination.6

4 years ago

4.2.0-pagination.5

4 years ago

4.2.0-pagination.4

4 years ago

4.2.0-pagination.3

4 years ago

4.2.0-pagination.2

4 years ago

4.2.0-pagination.1

4 years ago

4.1.1

4 years ago

4.1.0

4 years ago

4.0.0

4 years ago

4.0.0-prerelease.4

4 years ago

4.0.0-prerelease.3

4 years ago

4.0.0-prerelease.2

4 years ago

4.0.0-prelease.1

4 years ago

4.0.0-dev.10

4 years ago

4.0.0-dev.9

4 years ago

4.0.0-dev.7

4 years ago

4.0.0-dev.8

4 years ago

4.0.0-dev.6

4 years ago

4.0.0-dev.5

4 years ago

4.0.0-dev.2

4 years ago

4.0.0-dev.3

4 years ago

4.0.0-dev.4

4 years ago

3.4.12

4 years ago

4.0.0-dev.1

4 years ago

3.4.11

4 years ago

3.4.11-prerelease.1

4 years ago

3.4.10

4 years ago

3.4.9

4 years ago

3.4.8

4 years ago

3.4.6-testing.2

4 years ago

3.4.6-testing.1

4 years ago

3.4.7-1

4 years ago

3.4.7-0

4 years ago

3.4.6

4 years ago

3.4.5

4 years ago

3.4.6-alpha

4 years ago

3.4.5-alpha

4 years ago

3.4.4

4 years ago

3.4.4-alpha2

4 years ago

3.4.4-alpha

4 years ago

3.4.3

4 years ago

3.4.2

4 years ago

3.4.1

4 years ago

3.4.0

4 years ago

3.3.1

4 years ago

3.3.0

4 years ago

3.2.3

4 years ago

3.2.2

4 years ago

3.2.1

4 years ago

3.2.0

4 years ago

2.6.1

4 years ago

3.1.1

4 years ago

3.1.0

4 years ago

3.0.0

5 years ago

2.6.0

5 years ago

2.5.0

5 years ago

2.4.0

5 years ago

2.2.1

5 years ago

2.3.0

5 years ago

2.2.0

5 years ago

2.1.2

5 years ago

2.1.1

5 years ago

2.1.1-alpha.1

5 years ago

2.1.1-alpha.0

5 years ago

2.1.0

5 years ago

2.0.1-alpha.8

5 years ago

2.0.1-alpha.7

5 years ago

2.0.1-alpha.6

5 years ago

2.0.1-alpha.5

5 years ago

2.0.1-alpha.4

5 years ago

2.0.1-alpha.3

5 years ago

2.0.1-alpha.2

5 years ago

2.0.1-alpha.1

5 years ago

2.0.1-alpha.0

5 years ago

1.2.22-alpha.7

5 years ago

1.2.22-alpha.6

5 years ago

1.2.22-alpha.5

5 years ago

1.2.22-alpha.4

5 years ago

1.2.22-alpha.3

5 years ago

1.2.22-alpha.2

5 years ago

1.2.22-alpha.1

5 years ago

1.2.22-alpha.0

5 years ago

1.2.11-alpha.1

5 years ago

1.2.11-alpha.0

5 years ago

1.2.21

5 years ago

1.2.20

5 years ago

1.2.19

5 years ago

1.2.18

5 years ago

1.2.17

5 years ago

1.2.16

5 years ago

1.2.15

5 years ago

1.2.14

5 years ago

1.2.13

5 years ago

1.2.12

5 years ago

1.2.11

5 years ago

1.2.10

5 years ago

1.2.9

5 years ago

1.2.8

5 years ago

1.2.7

5 years ago

1.2.6

5 years ago

1.2.5

5 years ago

1.2.4

5 years ago

1.2.3

5 years ago

1.2.2

5 years ago

1.2.1

5 years ago

1.2.0

5 years ago

1.1.7

5 years ago

1.1.6

5 years ago

1.1.5

5 years ago

1.1.4

5 years ago

1.1.3

5 years ago

1.1.2

5 years ago

1.1.2-alpha.0

5 years ago

1.1.1

5 years ago

1.1.0

5 years ago

1.0.7

5 years ago

1.0.6

5 years ago

1.0.5

5 years ago

1.0.4

5 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

0.4.0-alpha.3

5 years ago

0.4.0-alpha.2

5 years ago

0.4.0-alpha.1

5 years ago

0.1.0-beta.1

5 years ago

0.1.0-beta.0

5 years ago

0.4.0-alpha.0

5 years ago

0.3.0-alpha.3

5 years ago

0.3.0-alpha.2

5 years ago

0.3.0-alpha.1

5 years ago

0.3.0-alpha.0

5 years ago

0.2.2-alpha.2

5 years ago

0.2.2-alpha.1

5 years ago

0.2.1-alpha.1

5 years ago

0.2.1-alpha.0

5 years ago

0.2.0

5 years ago

0.1.0-alpha.2

5 years ago

0.1.0-alpha.1

5 years ago

0.1.0-0

5 years ago

0.0.1-alpha-0.4

5 years ago

0.0.1-alpha-0.3

5 years ago

0.0.1-alpha-0.2

5 years ago

0.0.1-alpha-0.1

5 years ago

0.0.1-alpha

5 years ago