@codecademy/gamut-templates v2.7.0
CLIENT MODULES
Shared node modules for codecademy.com & co
This repository is a monorepo that we manage using Lerna. That means that we publish several packages to npm from the same codebase, including:
gamut
: Our React UI component library
gamut-styles
: Utility styles for gamut components and codecademy apps
gamut-icons
: SVG Icons for gamut components and codecademy apps
gamut-storybook
: A component development sandbox for Gamut components
Local development
- Run
yarn
in the root directory - Run
yarn lerna bootstrap
to prep each package in thepackages
directory for development
Running storybook
- Run
yarn start
to start the storybook server - Add new stories to
workspaces/gamut-storybook/stories
- Stories are written using storybook's Component Story Format
Publishing Modules
- Make your changes in a feature branch, and get another engineer to review your code
- After you've reviewed and tested your code, you can merge your branch into master.
- To merge, use the "squash and merge" button in github
- To generate an entry in the changelog for the module you changed, follow the commit message guide
- Once your branch is merged into master, it will be published automatically by CircleCI.
- You can check the master branch or CircleCI for the new version number
Publishing an alpha version of a module
Every PR that changes files in a package publishes alpha releases that you can use to test your changes across applications
- Create a PR
- In the github "checks" UI, find the "Publish Alpha" task
- Once this check has passed, click on it, and look through the output for the alpha version number
- Use this version in the other application you want to test your changes on
Commit Message Guide
Commits follow the Angular format
Commit Format
The squash and merge commit should follow a convention:
type(scope): message
Examples:
fix: fixes some component
test: adds test to component
feat(component): :sparkles: An awesome new component
This message should go inside the title field of the message:
Type
The type
determines what kind of version bump is needed. A fix
will create a patch
release, while a feat
will create a minor
release. Major releases are only created when the text BREAKING CHANGE:
is included in the Body
or Footer
of the commit message.
type
must be one of the following:
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- 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
- test: Adding missing tests or correcting existing tests
- ci: Changes to our CI configuration files and scripts
- build: Changes that affect the build system or external dependencies
Scope
Optional scope for your changes
Body
Optional extra description for your changes
This is where you should describe any version breaking changes by including the text BREAKING CHANGE:
with your description.
Publishing the storybook
- Storybook is built and published automatically when there are merges into the master branch
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago