Contributing

Getting Started

  • Install just

  • Fork and clone the repo

  • Create, activate & install dependencies

    $ python -m venv venv
$ . venv/bin/activate
$ just install

Coding style

Linters

  • $ just lint to run them all.

  • pylint & flake8: $ just lint-python

  • eslint: $ just lint-js

Formatter

Format js code with prettier:

$ npm run format

Commit messages

Prefix your commit messages with an emoji according to this list:

Commit type

Emoji

Initial commit
tada

:tada:

Version tag
bookmark

:bookmark:

New feature
sparkles

:sparkles:

Bugfix
bug

:bug:

Metadata
card_index

:card_index:

Documentation
books

:books:

Documenting source code
bulb

:bulb:

Performance
racehorse

:racehorse:

Cosmetic
lipstick

:lipstick:

Tests
rotating_light

:rotating_light:

Adding a test
white_check_mark

:white_check_mark:

General update
construction

:construction:

Improve format/structure
art

:art:

Move code
feet

:feet:

Refactor code
hammer

:hammer:

DRY up code
camel

:camel:

Removing code/files
hocho

:hocho:

Continuous Integration
green_heart

:green_heart:

Security
lock

:lock:

Upgrading dependencies
arrow_up

:arrow_up:

Downgrading dependencies
arrow_down

:arrow_down:

Lint
shirt

:shirt:

Translation
alien

:alien:

Text
pencil

:pencil:

Critical hotfix
ambulance

:ambulance:

Deploying stuff
rocket

:rocket:

Fixing on MacOS
apple

:apple:

Fixing on Linux
penguin

:penguin:

Fixing on Windows
checkered_flag

:checkered_flag:

Adding CI build system
construction_worker

:construction_worker:

Analytics or tracking code
chart_with_upwards_trend

:chart_with_upwards_trend:

Removing a dependency
heavy_minus_sign

:heavy_minus_sign:

Adding a dependency
heavy_plus_sign

:heavy_plus_sign:

Docker
whale

:whale:

Configuration files
wrench

:wrench:

Bundles update
package

:package:

Merging branches
twisted_rightwards_arrows

:twisted_rightwards_arrows:

Bad code / need improv.
hankey

:hankey:

Reverting changes
rewind

:rewind:

Breaking changes
boom

:boom:

Code review changes
ok_hand

:ok_hand:

Accessibility
wheelchair

:wheelchair:

Move/rename repository
truck

:truck:

Add component(s)
rice

:rice:

Other

Be creative

Guides

  • If you add a feature or fix a bug, it should also have a test.

  • Features and component should have a standalone demo in tests/apps/pages or tests/components/pages.

  • Bundle tests by package/system, components tests in tests/components.

  • Get a new external url

  • Download the url to vendors (eg: cd dazzler/assets/vendors && wget https://unpkg.com/react@16.8.6/umd/react.production.min.js)

  • Ensure new filename has version in it for cache breaking, vendors are copied flat.

  • Also download dev bundles to vendors if available.

  • Change the requirements urls and paths.

  • Create a new directory in src for the components.

  • Add webpack entrypoint.

  • Add a package in dazzler/components/<package_name>/__init__.py (Copy dazzler/components/core/__init__.py and change _name)

  • Add a build:dazzler::<package_name> npm command, add the comma

  • Build the components: $ just build.

  • Watch $ just watch.

  • Components styles should be using css classes primarily.

  • SCSS for styling, scoped with library-name-component-name.

  • Spinal casing for css classes.

  • extension .(t|j)sx for react components .(t|j)s otherwise.

  • Include a docstring for every component/props.

  • Include a test page in tests/components/pages.

  • Include an acceptance test in tests/components/test_[package_name].py

  • Run $ just publish