DRY

Don’t repeat yourself.

This is our components library. It mostly consists of Sass mixins, Vue components and Twig partials. They all are built with best practices in mind and common features we usually have to implement, but in a way we can adapt and customize them.

Sounds good? It is.

I want to contribute.

Noice. We like.

To get started you just have to clone it (git clone git@github.com:gridonic/components.git) and npm install it.

Now comes the fun part. If you want to add styles or Vue components, you can develop and test them with the included Storybook. Just run npm run storybook:serve and Storybook will automatically open your browser. Don’t know how to proceed? Head to the Storybook docs and familiarize yourself.

If you want to at Twig partials, feel free to do so. There is currently nothing set up for testing them.

How do I keep up with the extreme high quality of those components?

Ask your co-workers, Google, Stackoverflow or the linter of your trust. Or create a pull request if you want to be on the safe side.

Also make sure to write tests. Please for the love of god, do it. Just run npm run test to test your tests.

How do I publish this thing?

When ready to release, execute the following steps, given that all changes are commited in the master branch:

List all changes in the CHANGELOG.md
Bump your version and automatically create a git tag with npm version <type>, where type is patch, minor or major
Push the master branch (git push) and the tags (git push --tags)
Create a release in GitHub and fill the description with at least a link to the CHANGELOG.md. Add more information if necessary.

That’s it! A GitHub action will then automatically publish and update the @gridonic/components package on the npm registry.