Migrate markdownlint + issue templates

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,123 @@
+name: Bug Report
+description: Create a report to help us improve
+title: "[Bug]: "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        A clear and concise description of what the bug is.
+
+        > *__Note:__* Please do not submit support requests or "How to" questions here. Instead, please use our [Discussion forum](https://github.com/openvinotoolkit/anomalib/discussions/categories/q-a)
+  - type: dropdown
+    id: dataset
+    attributes:
+      label: Dataset
+      description: Which Dataset are you using?
+      options:
+        - "Avenue"
+        - "BTec"
+        - "Folder"
+        - "MVTec"
+        - "UCSD"
+        - "Other (please specify in the text field below)"
+    validations:
+      required: true
+  - type: dropdown
+    id: model
+    attributes:
+      label: Model
+      description: Which model are you using?
+      options:
+        - "CFlow"
+        - "CSFlow"
+        - "DFKDE"
+        - "DFM"
+        - "DRAEM"
+        - "FastFlow"
+        - "GANomaly"
+        - "PADiM"
+        - "PatchCore"
+        - "Reverse Distillation"
+        - "STFPM"
+        - "Other (please specify in the field below)"
+    validations:
+      required: true
+  - type: textarea
+    id: to-reproduce
+    attributes:
+      label: Steps to reproduce the behavior
+      description: Detailed steps or any other information you think is useful to reproduce the behavior.
+      placeholder: |
+        Steps to reproduce the behavior:
+        1. Install anomalib using '...'
+        2. Use/modify config '....'
+        3. Run using command '....'
+        4. See error
+    validations:
+      required: true
+  - type: textarea
+    id: os-information
+    attributes:
+      label: OS information
+      description: If you think OS information is necessary to reproduce the behavior, please provide it here.
+      value: |
+        OS information:
+        - OS: [e.g. Ubuntu 20.04]
+        - Python version: [e.g. 3.8.10]
+        - Anomalib version: [e.g. 0.3.6]
+        - PyTorch version: [e.g. 1.9.0]
+        - CUDA/cuDNN version: [e.g. 11.1]
+        - GPU models and configuration: [e.g. 2x GeForce RTX 3090]
+        - Any other relevant information: [e.g. I'm using a custom dataset]
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: If applicable, add screenshots to help explain your problem.
+  - type: dropdown
+    id: source
+    attributes:
+      label: Pip/GitHub
+      description: Did you install Anomalib from pip or from GitHub?
+      options:
+        - pip
+        - GitHub
+    validations:
+      required: true
+  - type: input
+    id: version-branch
+    attributes:
+      label: What version/branch did you use?
+  - type: textarea
+    id: config
+    attributes:
+      label: Configuration YAML
+      description: Please paste your configuration YAML here.
+      render: yaml
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: Please paste your logs here.
+      render: shell
+    validations:
+      required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/openvinotoolkit/anomalib/blob/main/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,35 @@
+name: Feature Request
+description: Suggest an idea for this project
+title: "[Feature Request]: "
+labels: ["Feature Request"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        We encourage our users to submit feature requests in our [Discussion forum](https://github.com/openvinotoolkit/anomalib/discussions/categories/ideas-feature-requests). You can use this template for consistency.
+
+  - type: textarea
+    id: concern
+    attributes:
+      label: Is your feature request related to a problem?
+      description: A clear and concise description of what the problem is.
+      placeholder: |
+        1. I'm always frustrated when [...]. It would be better if we could [...]
+        2. I would like to have [...] model/dataset to be supported in Anomalib.
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen. Add screenshots or code-blocks if necessary.
+      placeholder: |
+        I would like to have [...] to do this we would need to [...]
+        Here is what I would like to see [...]
+    validations:
+      required: true
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.

.markdownlint.yaml

@@ -0,0 +1,34 @@
+# Default state for all rules
+default: true
+
+# Path to configuration file to extend
+extends: null
+
+# MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time
+MD001: true
+
+# MD013/line-length - Line length
+MD013:
+  # Number of characters
+  line_length: 1000
+
+# This is not useful for some files such as `CHANGELOG.md`
+MD024:
+  # Only check sibling headings
+  allow_different_nesting: true
+  # Only check sibling headings
+  siblings_only: true
+
+MD033: false
+
+# If a page is printed, it helps if the URL is viewable.
+MD034: false # Bare URL used
+
+# This is needed for the anomalib tagline in the README
+MD036: false # Emphasis used instead of a header
+
+# Some md files have comments or links at the top of the files.
+MD041: false # First line in file should be a top level header
+
+# Badges have empty links
+MD042: false # No empty links

.pre-commit-config.yaml

@@ -78,8 +78,8 @@ repos:
     hooks:
       - id: prettier
 
-  - repo: https://github.com/jumanjihouse/pre-commit-hooks
-    rev: 2.1.6
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.32.2
     hooks:
       - id: markdownlint
 

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## v0.3.7
 
-## What's Changed
+### What's Changed
 
 - Feature/comet logging by @sherpan in <https://github.com/openvinotoolkit/anomalib/pull/517>
 - 🐞 Fix linting issues by @ashwinvaidya17 in <https://github.com/openvinotoolkit/anomalib/pull/535>
@@ -47,7 +47,7 @@ New Contributors
 
 ## v.0.3.6
 
-## What's Changed
+### What's Changed
 
 - Add publish workflow + update references to main by @ashwinvaidya17 in <https://github.com/openvinotoolkit/anomalib/pull/480>
 - Fix Dockerfile by @ORippler in <https://github.com/openvinotoolkit/anomalib/pull/478>
@@ -85,7 +85,7 @@ New Contributors
 
 ## v.0.3.5
 
-## What's Changed
+### What's Changed
 
 - 🐞 Fix inference for draem by @djdameln in <https://github.com/openvinotoolkit/anomalib/pull/470>
 - 🐞 🛠 Bug fix in the inferencer by @samet-akcay in <https://github.com/openvinotoolkit/anomalib/pull/475>
@@ -94,7 +94,7 @@ New Contributors
 
 ## v.0.3.4
 
-## What's Changed
+### What's Changed
 
 - Add encoding to LONG_DESCRIPTION in setup.py by @samet-akcay in <https://github.com/openvinotoolkit/anomalib/pull/419>
 - Fix visualization by @ORippler in <https://github.com/openvinotoolkit/anomalib/pull/417>
@@ -130,7 +130,7 @@ New Contributors
 
 ## v.0.3.3
 
-## What's Changed
+### What's Changed
 
 - 🚚 Move initialization log message to base class by @djdameln in <https://github.com/openvinotoolkit/anomalib/pull/363>
 - 🚚 Move logging from train.py to the getter functions by @samet-akcay in <https://github.com/openvinotoolkit/anomalib/pull/365>
@@ -155,7 +155,7 @@ New Contributors
 
 ## v.0.3.2
 
-## What's Changed
+### What's Changed
 
 - Refactor `AnomalyModule` and `LightningModules` to explicitly define class arguments. by @samet-akcay in <https://github.com/openvinotoolkit/anomalib/pull/315>
 - 🐞 Fix inferencer in Gradio by @ashwinvaidya17 in <https://github.com/openvinotoolkit/anomalib/pull/332>
@@ -176,7 +176,7 @@ New Contributors
 
 ## v.0.3.1
 
-## What's Changed
+### What's Changed
 
 - 🔧 Properly assign values to dataframe in folder dataset. by @samet-akcay in <https://github.com/openvinotoolkit/anomalib/pull/272>
 - ➕ Add warnings ⚠️ for inproper task setting in config files. by @samet-akcay in <https://github.com/openvinotoolkit/anomalib/pull/274>

README.md

@@ -33,7 +33,7 @@ Anomalib is a deep learning library that aims to collect state-of-the-art anomal
 
 ![Sample Image](./docs/source/images/readme.png)
 
-**Key features:**
+## Key features
 
 - The largest public collection of ready-to-use deep learning anomaly detection algorithms and benchmark datasets.
 - [**PyTorch Lightning**](https://www.pytorchlightning.ai/) based model implementations to reduce boilerplate code and limit the implementation efforts to the bare essentials.

anomalib/models/fastflow/README.md

@@ -22,13 +22,7 @@ All results gathered with seed `0`.
 
 ## [MVTec AD Dataset](https://www.mvtec.com/company/research/datasets/mvtec-ad)
 
----
-
-**NOTE**
-
-When the numbers are produced, early stopping callback (patience: 3) is used. It might be possible to achieve higher-metrics by increasing the patience.
-
----
+> **_NOTE:_** When the numbers are produced, early stopping callback (patience: 3) is used. It might be possible to achieve higher-metrics by increasing the patience.
 
 ### Image-Level AUC