diff --git a/README.md b/README.md index 14ab9d2e4..ce347c0d8 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,12 @@ Initialize and update submodules: git submodule update --init --recursive ``` +## Adding files +Certain file types need to be added to our linting rules manually: + +* **YAML**. If adding a YAML file (regardless of its extension), add it as an argument to the + `yamllint` command in [lint-tasks.yaml](lint-tasks.yaml). + ## Linting Before submitting a pull request, ensure you’ve run the linting commands below and either fixed any violations or suppressed the warning. diff --git a/lint-tasks.yaml b/lint-tasks.yaml index 2f4fbb218..df4a58769 100644 --- a/lint-tasks.yaml +++ b/lint-tasks.yaml @@ -36,7 +36,14 @@ tasks: cmds: - |- . "{{.G_LINT_VENV_DIR}}/bin/activate" - yamllint --strict . + yamllint \ + --config-file "tools/yscope-dev-utils/lint-configs/.yamllint.yml" \ + --strict \ + .gersemirc \ + .github/ \ + .yamllint.yaml \ + lint-tasks.yaml \ + taskfile.yaml cmake: internal: true