Are you interested in helping to improve the Spark Design System? We welcome contributions from both designers and engineers.
All contributions to Spark Design System are expected to follow our change workflow process.
Contributions are divided into two types: minor changes and substantial changes.
Minor changes include, but are not limited to:
Minor changes should begin with an issue on GitHub if you are unable to make the change yourself or are unsure if the change you want to make is needed. If you make the changes yourself, you can open a pull request for review.
If a minor change turns out to be substantial, the Spark team may ask you to go through the contribution workflow for substantial changes instead.
Substantial changes generally fall into two categories: New components and amendments to an existing component that change its design or behavior. This type of change requires you to complete our contribution workflow to determine if a new component or change to an existing component aligns with the direction Spark is going.
Spark is managed as a monorepo. All of the Spark source code lives in a single repo, but is released as separate packages using Lerna.
This repo consists of the design system packages, wrapped in an instance of Drizzle, a tool built by cloudfour, for displaying pattern libraries. Spark uses Drizzle for documentation and plain html code examples.
In the packages folder are Spark-Core and Spark-Extras. These are the files that are published to npm.
Open your browser to http://localhost:3000/.
Once you have determined that a new component or change is necessary, please open an issue using the "Contribution Proposal" issue template in GitHub to start the review process.
The Spark team will review your proposal and determine if it's a good fit. If it is, we will either add it to our backlog, or work with you on contributing the changes yourself.