@comicrelief/storybook1.18.14 • Public • Published
React components to build the Comic Relief front-end experience
To run CR Storybook locally
- Clone this repository
npm run storybook
- Visit http://localhost:9009/
Then import your component(s) into stories/index.js and render them like so:
Our target is to cover:
- interaction with component via user actions mainly
- component layout at it's lifecycle different states
In order to run unit tests
- For update mode :
yarn test-updateYou may need it to update snapshots after intentional layout changes
Getting Started as dependencies in your project
To build storybook components locally within an app, please use
npm link. Learn how to do this here
Then import your component(s) into components/index.js and rebuild build files via
Ensure packages are installed with correct version numbers by running:
npm install @comicrelief/storybook --save
In some cases there is documentation for a specific component in a
README.md inside its own directory.
Semantic Release Process
Git commit messages are used to automatically publish a new version of npm package. To achieve this, every commit message should have a type and a message in the format that is described below.
Travis CI will run a job automatically after PR is merged and analyze all commit messages since last npm release. Then semantic-release plugin will calculate new version according to this result.
Commit messages are expected to be in this format:
<type>(<scope>): <subject> <BLANK LINE> <body> <BLANK LINE> <footer>
subject is required.
Bugfix / patch
When there are no breaking changes or adding no new features. When we are fixing bugs or styles.
fix: A bug fix
Minor / Feature
When there is a new feature / functionality is added to the library
feat: A new feature
Major / breaking change
When there is a breaking change, we need to extend our commit message and add
BREAKING CHANGE: A description of the change to its body. This message can be added to any type of commit.
feat: A new feature BREAKING CHANGE: A description of the change
Automating commit message format
Commitizen library is added as npm dev dependency and it can be used to generate commit messages by answering a few questions and skipping the ones which are not relavent. Example workflow:
- Make code changes in your feature branch
git add .to add changed files and get ready to commit
This will start an interactive process to build commit message. Simply answer all questions or
Enter to skip.
- Repeat and follow rest of the GitHub workflow