CONTRIBUTING.md

Contributing

Getting Started

You will need Node.js version 8.9 or higher.

The development environment only supports Unix shells, i.e. Mac OS and Linux.

For Windows environments, consider using Windows Subsystem for Linux or a cloud-based development server.

Starting the Example Site

$ npm install
$ npm start

Navigate your browser to http://localhost:8080

Note: port may change depending on usage in your system, observe the terminal output when running the start command to see what port the site is running on. Note: this will generate library files in the vendor directory. These should not be modified manually and are ignored by git.

Building the Example Site for Github Pages

$ npm run build

Commit Messages

This repository will only support commit messages in the Angular format from Commitizen.

These messages are easily produced using the interactive commitizen interface

$ npm run b cz

Releases

Prepare the package for distribution:

$ npm run dist

This package follows Symantic Versioning use the following scripts to tag the package and update the version number.

$ npm run b patch 'some-unique-release-identifier'
$ npm run b minor 'some-unique-release-identifier'
$ npm run b major 'some-unique-release-identifier'

Programming Guidelines

Examples and templates will be written in Pug instead of HTML.

linting:

$ npm run b lint