Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.15 KB
Raw

Contributing

Contributing code

  1. Fork and clone the repository.

  2. Install the dependencies:

    bin/setup

  3. Create a new branch from main

    git checkout -b my-branch-name

  4. Make your changes, following our code-style (see below).

  5. Commit your changes, with a good commit message.

  6. 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.

Code style

CSS/Sass

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.

Documenting a component

Document each component in a README.md in each component's directory.