diff --git a/.codeclimate.yml b/.codeclimate.yml index f12d299e..ba84b0f5 100644 --- a/.codeclimate.yml +++ b/.codeclimate.yml @@ -16,11 +16,14 @@ engines: channel: "eslint-3" fixme: enabled: true + markdownlint: + enabled: true radon: enabled: true ratings: paths: - "**.css" - "**.js" + - "**.md" - "**.py" exclude_paths: [] diff --git a/README.md b/README.md index 6fb246d0..282731a8 100644 --- a/README.md +++ b/README.md @@ -38,22 +38,26 @@ TODO ## Development Install dependencies and development tools: + ```shell > make deps deps-test tools ``` Run quality checks: + ```shell > make quality ``` Run tests: + ```shell > make test ``` ## License -The code in this repository is licensed under the GPL v3 licence unless otherwise noted. +The code in this repository is licensed under the GPL v3 licence unless +otherwise noted. Please see `LICENSE` file for details.