Merge branch 'main' into test-coverage-json

Author: christopher-wild

.github/CONTRIBUTING.md

@@ -41,3 +41,7 @@ we ask contributors to stick to the following guidelines:
 7. Use [variable](https://www.python.org/dev/peps/pep-0008/#variable-annotations) and [function](https://www.python.org/dev/peps/pep-0008/#function-annotations)
    annotations.
 8. All methods should be thoroughly tested with PyTest (see [Testing]() below).
+9. Optionally run `autopep8 causal_testing` to prevent linter errors.
+10. Optionally run `isort causal_testing` to ensure imports are done in the right order (this will also help prevent linter errors).
+11. Format code using `black causal_testing`.
+12. Linting code using `pylint causal_testing` is advised.

.github/workflows/lint-format.yaml

@@ -0,0 +1,33 @@
+name: Linting and formatting
+
+on:
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: MegaLinter
+        id: ml
+        uses: oxsecurity/megalinter/flavors/python@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For detailed check status
+
+      - name: Archive production artifacts
+        if: ${{ success() }} || ${{ failure() }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: MegaLinter reports
+          path: |
+            megalinter-reports
+            mega-linter.log

.mega-linter.yaml

@@ -0,0 +1,10 @@
+# Configuration file for MegaLinter
+# See all available variables at https://oxsecurity.github.io/megalinter/configuration/ and in linters documentation
+
+ENABLE_LINTERS:
+  - PYTHON_PYLINT
+  - PYTHON_BLACK
+
+GITHUB_STATUS_REPORTER: true
+
+FILTER_REGEX_INCLUDE: (causal_testing/)