d-o-n-l-e-e/mayflower

Mayflower Mono Repo (react and pattern lab and documentation)

Mayflower

Mayflower is the enterprise design system for the Commonwealth of Massachusetts.

• Documentation: Documentation for the overall design system, including guiding principals.
• Implementations: Implementations of Mayflower in various languages and technologies. Each implementation has its own documentation explaining how to use and work with it.
  • Mayflower Patternlab
  • Mayflower React
• Mayflower Site: Static homepage site that is built with Mayflower React and Gatsby. Live at mayflower.digital.mass.gov

License

This project is licensed under the is licensed under the GNU General Public License v2.0 - see the LICENSE.txt file for details.

Continuous Integration using CircleCI

By default, each push to a remote branch will trigger build and tests for React Storybook and Patternlab, deploy the Patternlab site build bundle to S3, as well as run the distribution build for the mayflower-tokens package in the assets folder. For efficiency purposes, we allow CircleCI to bypass certain jobs based on the prefix of the branch name. Please only use these prefixes for the following scenarios:

Branch name prefix	Rule	Scenario
react/	This will bypass Patternlab build, deploy and tests	This prefix should only be used if all your changes are in the react folder, and nothing in the shared assets folder that could potentially impact the build of the Patternlab implementation
pattern/	This will bypass React Storybook build and tests	This prefix should only be used if all your changes are in the patternlab folder, and nothing in the shared assets folder that could potentially impact the build of the React implementation
site/	This will bypass all React and Patternlab and assets build, deploy and tests.	Only use this prefix if all the changes are in the site folder. e.g. Content changes to the homepage site that won't impact React, Patternlab and shared assets.
docs	This will bypass all React and Patternlab and assets build, deploy and tests, as well as Mayflower site build and tests.	Only use this prefix if all the changes are in the docs folder. e.g. Documentation changes for the repo and the Mayflower Gitbook that won't impact React, Patternlab, shared assets and the homepage static site.