-
Fork and clone the repository.
-
Install the dependencies:
bin/setup
-
Create a new branch from
main
git checkout -b my-branch-name
-
Make your changes, following our code-style (see below).
-
Commit your changes, with a good commit message.
-
Push your branch to GitHub and create a pull request.
Others will give constructive feedback. This is a time for discussion and improvements, and making the necessary changes will be required before we can merge the contribution.
We use stylelint to lint our CSS and Sass. It's configuration can
be found in .stylelintrc.json
. You can run stylelint from the command line via
npm run stylelint
, or integrate it with your editor.
Document each component in a README.md
in each component's directory.