Update linting configs. Add instructions for linting to README

Author: TotalDwarf03

.github/workflows/mega-linter.yml

@@ -81,7 +81,7 @@ jobs:
 
         # You can override MegaLinter flavor used to have faster performances
         # More info at https://megalinter.io/latest/flavors/
-        uses: oxsecurity/megalinter@v7
+        uses: oxsecurity/megalinter@1fc052d03c7a43c78fe0fee19c9d648b749e0c01
 
         id: ml
 
@@ -120,7 +120,7 @@ jobs:
       # Create pull request if applicable
       # (for now works only on PR from same repository, not from forks)
       - name: Create Pull Request with applied fixes
-        uses: peter-evans/create-pull-request@v6
+        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f
         id: cpr
         if: >-
           steps.ml.outputs.has_updated_sources == 1 &&
@@ -176,7 +176,7 @@ jobs:
         run: sudo chown -Rc $UID .git/
 
       - name: Commit and push applied linter fixes
-        uses: stefanzweifel/git-auto-commit-action@v5
+        uses: stefanzweifel/git-auto-commit-action@8621497c8c39c72f3e2a999a26b4ca1b5058a842
         if: >-
           steps.ml.outputs.has_updated_sources == 1 &&
           (

.gitignore

@@ -159,4 +159,12 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/
+
+# Ruff
+.ruff_cache/
+
+megalinter-reports/
+
+# DS_Store files
+.DS_Store

.markdownlint.yaml

@@ -0,0 +1 @@
+{ "MD013": false }

README.md

@@ -1,2 +1,50 @@
 # GitHub Repository Archive Script
-A Python utility used to archive old, unused GitHub repositories from an organisation.
+
+A Python utility used to archive old, unused GitHub repositories from an organisation.
+
+## Makefile
+
+This repository makes use of a Makefile to execute common commands. To view all commands, execute `make all`.
+
+```bash
+make all
+```
+
+## Linting and Testing
+
+### GitHub Actions
+
+This file contains 2 GitHub Actions to automatically lint and test code on pull request creation and pushing to the main branch.
+
+- [`ci.yml`](./.github/workflows/ci.yml)
+- [`mega-linter.yml`](./.github/workflows/mega-linter.yml)
+
+### Running Tests Locally
+
+To lint and test locally, you need to:
+
+1. Install dev dependencies
+
+    ```bash
+    make install-dev
+    ```
+
+2. Run all the linters
+
+    ```bash
+    make lint
+    ```
+
+3. Run all the tests
+
+    ```bash
+    make test
+    ```
+
+4. Run Megalinter
+
+    ```bash
+    make megalint
+    ```
+
+**Please Note:** This requires a docker daemon to be running. We recommend using [Colima](https://github.com/abiosoft/colima) if using MacOS or Linux. A docker daemon is required because Megalinter is ran from a docker image.