From aba407fff349a76dead6af5c60b45c26c57edcae Mon Sep 17 00:00:00 2001 From: powerOFMAX Date: Thu, 25 Jun 2020 21:08:05 -0300 Subject: [PATCH 1/3] Add Table of Contents to README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 6f4799f2..7b89a709 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,20 @@ The end goal of this tool: - Build guidelines for code layout and format - Automate the process to help streamline code reviews + +## Table of Contents + +* [How it works](#how-it-works) +* [Supported linters](#supported-linters) +* [Usage](#how-to-use) +* [Environment variables](#environment-variables) +* [Disable rules](#disabling-rules) +* [Docker Hub](#docker-hub) +* [Run Super-Linter locally](#running-super-linter-locally-troubleshootingdebuggingenhancements) + * [CI / CT/ CD](#cictcd) +* [Limitations](#limitations) + + ## How it Works The super-linter finds issues and reports them to the console output. Fixes are suggested in the console output but not automatically fixed, and a status check will show up as failed on the pull request. From 04e7807d4e7ff7203650d421ca3d6564f0cf0253 Mon Sep 17 00:00:00 2001 From: Thomas Hughes Date: Thu, 25 Jun 2020 19:19:12 -0500 Subject: [PATCH 2/3] Add contributing to ToC --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b89a709..6aabfb51 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ The end goal of this tool: * [Run Super-Linter locally](#running-super-linter-locally-troubleshootingdebuggingenhancements) * [CI / CT/ CD](#cictcd) * [Limitations](#limitations) - +* [Contributing](#how-to-contribute) ## How it Works From b1a578b42c4c5469d47c453545cbdde7331eda64 Mon Sep 17 00:00:00 2001 From: Thomas Hughes Date: Thu, 25 Jun 2020 19:22:10 -0500 Subject: [PATCH 3/3] Change * for - for consistency --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6aabfb51..d21b666b 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,16 @@ The end goal of this tool: ## Table of Contents -* [How it works](#how-it-works) -* [Supported linters](#supported-linters) -* [Usage](#how-to-use) -* [Environment variables](#environment-variables) -* [Disable rules](#disabling-rules) -* [Docker Hub](#docker-hub) -* [Run Super-Linter locally](#running-super-linter-locally-troubleshootingdebuggingenhancements) - * [CI / CT/ CD](#cictcd) -* [Limitations](#limitations) -* [Contributing](#how-to-contribute) +- [How it works](#how-it-works) +- [Supported linters](#supported-linters) +- [Usage](#how-to-use) +- [Environment variables](#environment-variables) +- [Disable rules](#disabling-rules) +- [Docker Hub](#docker-hub) +- [Run Super-Linter locally](#running-super-linter-locally-troubleshootingdebuggingenhancements) + - [CI / CT/ CD](#cictcd) +- [Limitations](#limitations) +- [Contributing](#how-to-contribute) ## How it Works