actions/lint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-21 21:50:59 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add Table of Contents to README

Browse source
This commit is contained in:
powerOFMAX 2020-06-25 21:08:05 -03:00
parent e18ef2cd3b
commit aba407fff3
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -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.