Skip to content

Latest commit

 

History

History
34 lines (18 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

34 lines (18 loc) · 1.41 KB

Contributing

Developer Tooling.

This repository leverages gulp to run automated build tasks. If your system supports npm, you can run the following commands from the root of the project to get set up:

npm install

Installs all dependencies needed to run developer tooling scripts.

npm run build / gulp buildAll

Runs all relevant build scripts (listed below).

npm run build:css / gulp buildCSS

Converts the LESS in ./less to the final dark-heresy.css.

npm run build:watch / gulp

Runs the LESS -> CSS builder in watch mode so that changes made to the LESS files will automatically compile to CSS.

Code

Here are some guidelines for contributing code to this project.

To contribute code, fork this project and submit a pull request (PR) against the correct development branch.

Style

Please attempt to follow code style present throughout the project. An ESLint profile is included to help with maintaining a consistent code style. All warnings presented by the linter should be resolved before an PR is submitted.

  • gulp lint or npm run lint - Run the linter and display any issues found.
  • gulp lint --fix or npm run lint:fix - Automatically fix any code style issues that can be fixed.