Extend GitHub actions guidance

econia-labs · Feb 1, 2024 · 15afbfc · 15afbfc
1 parent 3af71d5
commit 15afbfc
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -12,3 +12,11 @@ From the repository root directory:
 ```sh
 source src/sh/pre-commit.sh
 ```
+
+See the `cfg/` directory for assorted formatter and linter configurations.
+
+### GitHub actions
+
+This repository uses [GitHub actions](https://docs.github.com/en/actions) to perform
+assorted status checks. For example if you submit a pull request but do not run
+[`pre-commit`](#pre-commit) then your pull request might get blocked.
diff --git a/cfg/markdownlint-config.yaml b/cfg/markdownlint-config.yaml
@@ -0,0 +1,3 @@
+MD013:
+  strict: true
+default: true
diff --git a/cfg/pre-commit-config.yaml b/cfg/pre-commit-config.yaml
@@ -16,7 +16,11 @@ repos:
   rev: '0.7.17'
 -
   hooks:
-  - id: 'markdownlint-fix'
+  -
+    args:
+    - '--config'
+    - 'cfg/markdownlint-config.yaml'
+    id: 'markdownlint-fix'
   repo: 'https://github.com/igorshubovych/markdownlint-cli'
   rev: 'v0.39.0'
 -

diff --git a/cfg/yamllint-config.yaml b/cfg/yamllint-config.yaml
@@ -1,4 +1,3 @@
-# Used by pre-commit.
 extends: 'default'
 rules:
   braces: