Get Involved

Table Of Contents

We are happy to listen to your opinions and feedback, and welcome you to get involved.

Community

Contribute

Any contributions are welcome, such as docs, bug fix and new feature.

Rules

In view of ease of maintenance, we draw up some rules.

Conventional Commits Specification

Please follow the Conventional Commits Specification .

For example:

  • bug fix: fix: correct typos
  • new feature: feat: add the foobar parameter
  • docs: docs: document the foobar parameter
  • style: style: change the background color to blue
  • rebuild assets: chore: rebuild assets

Develop

The theme relies on npm and webpack for building assets: JS, CSS, fonts etc.

The source code were placed in src directory.

Install dependencies

1$ npm install

Rebuild assets

1$ npm run build

npm run watch will rebuild assets on change.

Preview

1$ npm run serve

Copyright

CC BY-NC-ND 4.0

Comments