You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.

This page is relevant to you when you are planning to contribute to the Blueriq Material theme.

 

The new Blueriq Material theme based on Angular is planned to be opensource and published on GitHub (GitHub is the largest software development platform for opensource projects). Because we want the open source community to contribute to this project we want to commit ourselves to the contribution style commits supported by GitHub and used by Angular itself. This way we try to ensure that the threshold for contributing is as low as possible.

In order to understand the summary below you need to reed the Commit Message Guidelines.

Summary commit guideline Blueriq Material theme

If we commit changes we would like to use the guidelines that are market standard, because the code will be open source. 

The format we will using is:

<type>(<scope>): <subject> #<BQ0000>
<BLANK LINE>
<body>

* The header (first line of the message) is mandatory and the scope of the header is optional.

Since we need an reference to our internal issue tracking system we provide the issue number at the end of the subject in the commit message. The internal issues are prefixed with #BQ-.

The commit message could look like this:

fix(button): primary color #BQ-0000

 

Buttons should have the primary color and they should have some spacing

The following types and scopes can be used (these are the default Types and Scopes as defined here: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type):

Type
build
ci
docs
feat
fix
perf
refactor
style
test
Scope
animations
common
compiler
compiler-cli
core
elements
forms
http
language-service
platform-browser
platform-browser-dynamic
platform-server

platform-webworker

platform-webworker-dynamic

router
service-worker
upgrade

For more information --> Commit Message Guidelines

Didn't find the answer you were looking for? Try the advanced search!