FEAT: Fix Linting Errors (REVISIT) (#19)

* Updated bug_report OS order

* Updated linter to lint entire codebase

* Using FILTER_REGEX Include and Exclude

* Using FILTER_REGEX_EXCLUDE

* Updating REGEX

* Regex should be good now

* Updated linter and python-package workflows

* Fixed linting issues in  files

* Updated docs

* Checking if this fixes issues

* No more `linter.yml`

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,58 +1,59 @@
-name: "Bug Report"
-description: Report a bug. For security vulnerabilities see Report a security vulnerability in the templates.
-title: "BUG: <Please write a comprehensive title after the 'BUG: ' prefix>"
-labels: [Bug]
+---
+  name: "Bug Report"
+  description: Report a bug. For security vulnerabilities see Report a security vulnerability in the templates.
+  title: "BUG: <Please write a comprehensive title after the 'BUG: ' prefix>"
+  labels: [Bug]
 
-body:
-- type: textarea
-  attributes: 
-    label: "Describe the issue:"
-  validations:
-    required: true
+  body:
+  - type: textarea
+    attributes: 
+      label: "Describe the issue:"
+    validations:
+      required: true
 
-- type: textarea
-  attributes:
-    label: "Reproduce the code example:"
-    description: >
-      A short code example that reproduces the problem/missing feature. It
-      should be self-contained, i.e., can be copy-pasted into the Python
-      interpreter or run as-is via `python myproblem.py`.
-    placeholder: |
-      << your code here >>
-    render: python
-  validations:
-    required: false
-
-- type: textarea
-  attributes:
-    label: "Error message:"
-    description: >
-      Please include full error message, if any.
-    placeholder: |
-      << Full traceback starting from `Traceback: ...` >>
-    render: shell
-  validations:
-    required: false
+  - type: textarea
+    attributes:
+      label: "Reproduce the code example:"
+      description: >
+        A short code example that reproduces the problem/missing feature. It
+        should be self-contained, i.e., can be copy-pasted into the Python
+        interpreter or run as-is via `python myproblem.py`.
+      placeholder: |
+        << your code here >>
+      render: python
+    validations:
+      required: false
+    
+  - type: textarea
+    attributes:
+      label: "Error message:"
+      description: >
+        Please include full error message, if any.
+      placeholder: |
+        << Full traceback starting from `Traceback: ...` >>
+      render: shell
+    validations:
+      required: false
 
-- type: textarea
-  attributes:
-    label: "Screenshots"
-    description: If applicable, add screenshots to help explain your problem.
-    value: |
-      ![DESCRIPTION](LINK.png)
-    render: bash
-  validations:
-    required: false
+  - type: textarea
+    attributes:
+      label: "Screenshots"
+      description: If applicable, add screenshots to help explain your problem.
+      value: |
+        ![DESCRIPTION](LINK.png)
+      render: bash
+    validations:
+      required: false
 
-- type: dropdown
-  id: os
-  attributes:
-    label: "OS"
-    description: What is the impacted environment?
-    multiple: true
-    options:
-      - Mac
-      - Windows
-      - Linux
-  validations:
-    required: false
+  - type: dropdown
+    id: os
+    attributes:
+      label: "OS"
+      description: What is the impacted environment?
+      multiple: true
+      options:
+        - Mac
+        - Windows
+        - Linux
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/documentation.yml

@@ -1,26 +1,27 @@
-name: Documentation
-description: Report an issue related to documentation.
-title: "DOC: <Please write a comprehensive title after the 'DOC: ' prefix>"
-labels: [Documentation]
+---
+  name: Documentation
+  description: Report an issue related to documentation.
+  title: "DOC: <Please write a comprehensive title after the 'DOC: ' prefix>"
+  labels: [Documentation]
 
-body:
-- type: textarea
-  attributes: 
-    label: "Issue with current documentation:"
-    placeholder: |
-      The DOCSTRING for function `function_with_issue()`
-      in `/directory/subdirectory/file_with_issue.py`
-      reports that it returns a `dict` but it actually returns a `list`
-    description: >
-      Please make sure to follow the NumpyDoc format outlined here:
-      https://numpydoc.readthedocs.io/en/latest/format.html.
+  body:
+  - type: textarea
+    attributes: 
+      label: "Issue with current documentation:"
+      placeholder: |
+        The DOCSTRING for function `function_with_issue()`
+        in `/directory/subdirectory/file_with_issue.py`
+        reports that it returns a `dict` but it actually returns a `list`
+      description: >
+        Please make sure to follow the NumpyDoc format outlined here:
+        https://numpydoc.readthedocs.io/en/latest/format.html.
 
-- type: textarea
-  attributes:
-    label: "Where the issue is and what it impacts:"
-    placeholder: |
-      `function_with_issue()` is located in:
-      `/directory/subdirectory/file_with_issue.py`
-    description: >
-      Please describe where the issue in documentation is
-      like `/directory/subdirectory/file_with_issue.py`.
+  - type: textarea
+    attributes:
+      label: "Where the issue is and what it impacts:"
+      placeholder: |
+        `function_with_issue()` is located in:
+        `/directory/subdirectory/file_with_issue.py`
+      description: >
+        Please describe where the issue in documentation is
+        like `/directory/subdirectory/file_with_issue.py`.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,18 +1,19 @@
-name: Feature Request
-description: Describe your feature request here.
-title: "FEAT: <Please write a comprehensive title after the 'FEAT: ' prefix>"
-labels: [Feature]
+---
+  name: Feature Request
+  description: Describe your feature request here.
+  title: "FEAT: <Please write a comprehensive title after the 'FEAT: ' prefix>"
+  labels: [Feature]
 
-body:
-- type: markdown
-  attributes:
-    value: >
-      If you're looking to request a new feature or change in functionality,
-      please describe the change hear.  Please include any links or related
-      issues that are relevant to the feature request.
+  body:
+  - type: markdown
+    attributes:
+      value: >
+        If you're looking to request a new feature or change in functionality,
+        please describe the change hear.  Please include any links or related
+        issues that are relevant to the feature request.
 
-- type: textarea
-  attributes:
-    label: "Proposed new feature or change:"
-  validations:
-    required: true
+  - type: textarea
+    attributes:
+      label: "Proposed new feature or change:"
+    validations:
+      required: true

.github/semantic.yml

@@ -1,17 +1,18 @@
-# Always validate the PR title, and ignore the commits
-titleOnly: true
-# By default types specified in commitizen/conventional-commit-types is used.
-# See: https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json
-# You can override the valid types
-types:
-  - feat
-  - fix
-  - docs
-  - style
-  - refactor
-  - perf
-  - test
-  - build
-  - ci
-  - chore
-  - revert
+---
+  # Always validate the PR title, and ignore the commits
+  titleOnly: true
+  # By default types specified in commitizen/conventional-commit-types is used.
+  # See: https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json
+  # You can override the valid types
+  types:
+    - feat
+    - fix
+    - docs
+    - style
+    - refactor
+    - perf
+    - test
+    - build
+    - ci
+    - chore
+    - revert

.github/workflows/dependency-review.yml

@@ -1,20 +1,21 @@
-# Dependency Review Action
-#
-# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
-#
-# Source repository: https://github.com/actions/dependency-review-action
-# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
-name: 'Dependency Review'
-on: [pull_request]
+---
+  # Dependency Review Action
 
-permissions:
-  contents: read
+  # This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
 
-jobs:
-  dependency-review:
-    runs-on: ubuntu-latest
-    steps:
-      - name: 'Checkout Repository'
-        uses: actions/checkout@v3
-      - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v2
+  # Source repository: https://github.com/actions/dependency-review-action
+  # Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
+  name: 'Dependency Review'
+  on: [pull_request]
+
+  permissions:
+    contents: read
+
+  jobs:
+    dependency-review:
+      runs-on: ubuntu-latest
+      steps:
+        - name: 'Checkout Repository'
+          uses: actions/checkout@v3
+        - name: 'Dependency Review'
+          uses: actions/dependency-review-action@v3

.github/workflows/linter.yml

@@ -1,56 +1,54 @@
----
-    #################################
-    #################################
-    ## Super Linter GitHub Actions ##
-    #################################
-    #################################
-    name: Lint Code Base
-
-    #
-    # Documentation:
-    # https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions
-    #
-
-    #############################
-    # Start the job on all push #
-    #############################
-    on:
-      push:
-        branches-ignore: [master, main]
-        # Remove the line above to run when pushing to master
-      pull_request:
-        branches: [master, main]
-
-    ###############
-    # Set the Job #
-    ###############
-    jobs:
-      build:
-        # Name the Job
-        name: Lint Code Base
-        # Set the agent to run on
-        runs-on: ubuntu-latest
-
-        ##################
-        # Load all steps #
-        ##################
-        steps:
-          ##########################
-          # Checkout the code base #
-          ##########################
-          - name: Checkout Code
-            uses: actions/checkout@v3
-            with:
-              # Full git history is needed to get a proper
-              # list of changed files within `super-linter`
-              fetch-depth: 0
-
-          ################################
-          # Run Linter against code base #
-          ################################
-          - name: Lint Code Base
-            uses: docker://github/super-linter:latest
-            env:
-              VALIDATE_ALL_CODEBASE: false
-              DEFAULT_BRANCH: main
-              GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+# ---
+#   #################################
+#   #################################
+#   ## Super Linter GitHub Actions ##
+#   #################################
+#   #################################
+#   name: Lint Code Base
+
+#   #
+#   # Documentation:
+#   # https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions
+#   #
+
+#   #############################
+#   # Start the job on all push #
+#   #############################
+#   on:
+#     push:
+#     pull_request:
+#       branches: [master, main]
+
+#   ###############
+#   # Set the Job #
+#   ###############
+#   jobs:
+#     build:
+#       name: Lint Code Base
+#       # Set the agent to run on
+#       runs-on: ubuntu-latest
+
+#       ##################
+#       # Load all steps #
+#       ##################
+#       steps:
+#         ##########################
+#         # Checkout the code base #
+#         ##########################
+#         - name: Checkout Code
+#           uses: actions/checkout@v3
+#           with:
+#             # Full git history is needed to get a proper
+#             # list of changed files within `super-linter`
+#             fetch-depth: 0
+
+#         ################################
+#         # Run Linter against code base #
+#         ################################
+#         - name: Lint Code Base
+#           uses: docker://github/super-linter:latest
+#           env:
+#             FILTER_REGEX_EXCLUDE: (.*build\/.*|.*dist\/.*|.*docs\/.*)
+#             VALIDATE_ALL_CODEBASE: true
+#             DEFAULT_BRANCH: main
+#             GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}