Guidelines for contributing

First of all, thank you for considering contributing! Below are guidelines for helping you contribute to this repository.

Raising an issue

Bugs

Provide context to the bug and list any explorations you made. Reproducible examples are highly encouraged and may be asked for if not initially included.

Features

Have an idea, big or small, for the package? Let the team know! Feature suggestions encourage development, give the team an idea how you and others use the package, and let you help shape the creative direction of the package.

Submitting a pull request

Commit messages

This is adapted from the Angular team’s commit guidelines

Format of the commit message

A commit message consists of a header, a body, and a possible footer, separated by a blank line.

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

<type>

value description
feat feature
fix bug fix
docs documentation
style formatting, missing semi colons, …
test adding missing tests
chore maintenance

<scope>

Scope can be anything specifying what the commit affects. For example renderBadge, tableInput, background, css, …

Use * if there isn’t a more fitting scope.

<subject>

This is a very short description of the change.

  • use imperative, present tense: “change” not “changed” nor “changes”
  • don’t capitalize first letter
  • no dot (.) at the end

<body>

As in <subject> use imperative, present tense: “change” not “changed” nor “changes”. Include the motivation for the change and contrasts with previous behavior.