Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

78 lines (52 loc) · 2.88 KB
Raw

Contributing to Keyboard CSS

🙏 I would ❤️ for you to contribute to Keyboard CSS and help make it even better than it is today!

Developing

Start by cloning the project and installing all dependencies:

git clone https://github.com/shhdharmen/keyboard-css.git
cd keyboard-css
npm i

Run the playground app:

npm start

Building

Building and publishing is done through semantic-release and github actions. You can check the flow at release.yml and .releaserc.json.

As the @semantic-release/npm plugin uses the npm CLI to update the package.json version and publish the package, all npm hook scripts will be executed.

We are using the postversion hook so it will be executed during the prepare step of @semantic-release/npm, which allow for example to update files before committing them with the @semantic-release/git plugin.

More at: How can I use a npm build script that requires the package.json's version ?.

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more specs (unit-tests).
  • All public API methods must be documented.

Commit Message Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the Inspector changelog.

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

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

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

The footer should contain a closing reference to an issue if any.

Samples: (even more samples)

docs(changelog): update changelog to beta.5
fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.