Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

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(Angular [editor]) 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 our-self 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.

See the Commit Message Guidelines for more information.

Summary commit guideline Blueriq Material theme

If we commit issues 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>
<BLANK LINE>
<body>

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 Type's 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
 
 
 
 
 
 
 
 

...

For more information --> Commit Message Guidelines

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

...