From 7e5e3035af46442df1f37ea6fcf7c6bc11ec3431 Mon Sep 17 00:00:00 2001
From: Tarun Mamidi <tmamidi@uab.edu>
Date: Thu, 25 Jan 2024 13:33:51 -0600
Subject: [PATCH] adds linting workflow

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 26 +++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++
 .github/pull_request_template.md          | 22 +++++++++++++
 .github/workflows/linting.yml             | 40 +++++++++++++++++++++++
 README.md                                 |  5 +++
 5 files changed, 113 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 .github/pull_request_template.md
 create mode 100644 .github/workflows/linting.yml

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..07b99f5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment used**
+OS, relevant tool versions, etc.
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..11fc491
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+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 [...]
+
+**Describe the solution you'd like**
+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.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..c371bee
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,22 @@
+* **Please check if the PR fulfills these requirements**
+- [ ] Tested as per the documentation and they passed
+- [ ] Docs have been added / updated (for bug fixes / features)
+
+
+* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
+
+
+
+* **What is the current behavior?** (You can also link to an open issue here)
+
+
+
+* **What is the new behavior (if this is a feature change)?**
+
+
+
+* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?)
+
+
+
+* **Other information**:
diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml
new file mode 100644
index 0000000..233be9f
--- /dev/null
+++ b/.github/workflows/linting.yml
@@ -0,0 +1,40 @@
+name: Linting- Markdown,Shell
+
+on:
+  push:
+  workflow_dispatch:
+
+jobs:
+  markdown-linting:
+    name: Markdown lint
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: markdownlint-cli
+        uses: nosborn/github-action-markdown-cli@v3.3.0
+        with:
+          files: .
+          config_file: ".markdownlint.json"
+          # dot: false
+          # ignore_files: '".git*/**"'
+
+
+  markdown-check-links:
+    name: Markdown - checking links
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          config-file: ".markdownlint.json"
+
+  shellcheck:
+    name: Shellcheck
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run ShellCheck
+        uses: ludeeus/action-shellcheck@master
diff --git a/README.md b/README.md
index 102beb5..7c314a6 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,10 @@
 # DITTO
 
+<!-- markdown-link-check-disable -->
+[![Perform linting -
+Markdown](https://github.com/uab-cgds-worthey/DITTO/actions/workflows/linting.yml/badge.svg)](https://github.com/uab-cgds-worthey/DITTO/actions/workflows/linting.yml)
+<!-- markdown-link-check-enable -->
+
 ***!!! For research purposes only !!!***
 
 > **_NOTE:_**  In a past life, DITTO used a different remote Git management provider, [UAB