Address markdownlint issues (#460)

* Fixed markdown formatting

* Add reference

* Add refactor option to pull request template

Co-authored-by: someone <someone@example.com>

.devcontainer/devcontainer.json

@@ -1,56 +1,46 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
 // https://github.com/microsoft/vscode-dev-containers/tree/v0.187.0/containers/docker-existing-dockerfile
 {
-	"name": "Anomalib Development Environment",
-	// Sets the run context to one level up instead of the .devcontainer folder.
-	"context": "..",
-	// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
-	"dockerFile": "../Dockerfile",
-	// Set *default* container specific settings.json values on container create.
-	"settings": {
-		"python.pythonPath": "/opt/conda/bin/python",
-		"python.formatting.provider": "black",
-		"editor.formatOnSave": true,
-		"python.formatting.blackArgs": [
-			"--line-length",
-			"120"
-		],
-		"editor.codeActionsOnSave": {
-			"source.organizeImports": true
-		},
-		"python.linting.enabled": true,
-		"python.linting.flake8Enabled": true,
-		"python.linting.flake8Args": [
-			"--max-line-length=120"
-		],
-		"python.testing.cwd": ".",
-		"python.linting.lintOnSave": true,
-		"python.testing.unittestEnabled": false,
-		"python.testing.nosetestsEnabled": false,
-		"python.testing.pytestEnabled": true,
-		"python.testing.pytestArgs": [
-			"tests"
-		]
-	},
-	// Add the IDs of extensions you want installed when the container is created.
-	"extensions": [
-		"ms-python.python",
-		"njpwerner.autodocstring",
-		"streetsidesoftware.code-spell-checker",
-		"eamodio.gitlens",
-		"littlefoxteam.vscode-python-test-adapter"
-	],
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	// "forwardPorts": [],
-	// Uncomment the next line to run commands after the container is created - for example installing curl.
-	// "postCreateCommand": "apt-get update && apt-get install -y curl",
-	// Uncomment when using a ptrace-based debugger like C++, Go, and Rust
-	"runArgs": [
-		"--gpus=all",
-		"--shm-size=20g"
-	]
-	// Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker.
-	// "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ],
-	// Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
-	// "remoteUser": "vscode"
+  "name": "Anomalib Development Environment",
+  // Sets the run context to one level up instead of the .devcontainer folder.
+  "context": "..",
+  // Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
+  "dockerFile": "../Dockerfile",
+  // Set *default* container specific settings.json values on container create.
+  "settings": {
+    "python.pythonPath": "/opt/conda/bin/python",
+    "python.formatting.provider": "black",
+    "editor.formatOnSave": true,
+    "python.formatting.blackArgs": ["--line-length", "120"],
+    "editor.codeActionsOnSave": {
+      "source.organizeImports": true
+    },
+    "python.linting.enabled": true,
+    "python.linting.flake8Enabled": true,
+    "python.linting.flake8Args": ["--max-line-length=120"],
+    "python.testing.cwd": ".",
+    "python.linting.lintOnSave": true,
+    "python.testing.unittestEnabled": false,
+    "python.testing.nosetestsEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.testing.pytestArgs": ["tests"]
+  },
+  // Add the IDs of extensions you want installed when the container is created.
+  "extensions": [
+    "ms-python.python",
+    "njpwerner.autodocstring",
+    "streetsidesoftware.code-spell-checker",
+    "eamodio.gitlens",
+    "littlefoxteam.vscode-python-test-adapter"
+  ],
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+  // Uncomment the next line to run commands after the container is created - for example installing curl.
+  // "postCreateCommand": "apt-get update && apt-get install -y curl",
+  // Uncomment when using a ptrace-based debugger like C++, Go, and Rust
+  "runArgs": ["--gpus=all", "--shm-size=20g"]
+  // Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker.
+  // "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ],
+  // Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
+  // "remoteUser": "vscode"
 }

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,35 +1,40 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Describe the bug**
+
 - A clear and concise description of what the bug is.
 
 **To Reproduce**
+
 Steps to reproduce the behavior:
+
 1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+1. Click on '....'
+1. Scroll down to '....'
+1. See error
 
 **Expected behavior**
+
 - A clear and concise description of what you expected to happen.
 
 **Screenshots**
+
 - If applicable, add screenshots to help explain your problem.
 
 **Hardware and Software Configuration**
+
 - OS: [Ubuntu, OD]
 - NVIDIA Driver Version [470.57.02]
 - CUDA Version [e.g. 11.4]
 - CUDNN Version [e.g. v11.4.120]
 - OpenVINO Version [Optional e.g. v2021.4.2]
 
-
 **Additional context**
+
 - Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +1,23 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**
-  - A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 
 **Describe the solution you'd like**
-  - A clear and concise description of what you want to happen.
+
+- A clear and concise description of what you want to happen.
 
 **Describe alternatives you've considered**
-  - A clear and concise description of any alternative solutions or features you've considered.
+
+- A clear and concise description of any alternative solutions or features you've considered.
 
 **Additional context**
-  - Add any other context or screenshots about the feature request here.
+
+- Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -7,6 +7,7 @@
 ## Changes
 
 - [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] Refactor (non-breaking change which refactors the code base)
 - [ ] New feature (non-breaking change which adds functionality)
 - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
 - [ ] This change requires a documentation update

.mdlrc

@@ -0,0 +1 @@
+style "#{File.dirname(__FILE__)}/markdownlint.rb"

.pre-commit-config.yaml

@@ -22,13 +22,6 @@ repos:
     hooks:
       - id: isort
 
-  # yaml formatting
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v2.7.1
-    hooks:
-      - id: prettier
-        types: [yaml]
-
   # python code analysis
   - repo: https://github.com/PyCQA/flake8
     rev: 4.0.1
@@ -76,3 +69,13 @@ repos:
       - id: nbqa-flake8
         args: ["--max-line-length=120", "--ignore=E203,W503"]
       - id: nbqa-pylint
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.7.1
+    hooks:
+      - id: prettier
+
+  - repo: https://github.com/jumanjihouse/pre-commit-hooks
+    rev: 2.1.6
+    hooks:
+      - id: markdownlint