CI: Use commitlint to check PR titles (#18)

Author: adrien-berchet

.codespellrc

@@ -0,0 +1,2 @@
+[codespell]
+skip = .git/*

.github/workflows/commitlint.yml

@@ -0,0 +1,19 @@
+name: Check PR titles using commitlint
+
+on:
+  pull_request:
+    types: [edited, opened, reopened, synchronize]
+
+jobs:
+  check-pr-title:
+    name: Check PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+      - run: npm install -g --force commitlint @commitlint/cli commitlint-plugin-cleanfeet
+      - run: npm install conventional-changelog-conventionalcommits
+      - run: touch .git/COMMIT_EDITMSG
+      - run: echo ${{ github.event.pull_request.title }} | commitlint

dir_content_diff/base_comparators.py

@@ -21,8 +21,6 @@
 class BaseComparator(ABC):
     """Base Comparator class."""
 
-    # pylint: disable=no-self-use
-
     def __init__(
         self,
         default_load_kwargs=None,

tests/test_base.py

@@ -1,6 +1,5 @@
 """Test the base features of the ``dir-content-diff`` package."""
 # pylint: disable=missing-function-docstring
-# pylint: disable=no-self-use
 # pylint: disable=redefined-outer-name
 # pylint: disable=unused-argument
 # pylint: disable=use-implicit-booleaness-not-comparison

tests/test_pandas.py

@@ -1,6 +1,5 @@
 """Test the Pandas extension of the ``dir-content-diff`` package."""
 # pylint: disable=missing-function-docstring
-# pylint: disable=no-self-use
 # pylint: disable=redefined-outer-name
 # pylint: disable=unused-argument
 # pylint: disable=use-implicit-booleaness-not-comparison

tox.ini

@@ -41,7 +41,7 @@ commands =
 basepython = python3.8
 deps =
     pre-commit
-    pylint
+    pylint>=2.14
 commands =
     pre-commit run --all-files --show-diff-on-failure
     pylint -j {env:PYLINT_NPROCS:1} {[base]files}