actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-09-19 02:47:08 -04:00
Code Issues Projects Releases Packages Wiki Activity

docs: clarify action behavior in README

Browse source
This commit is contained in:
Zeke Sikelianos 2020-05-04 21:06:29 -07:00 committed by GitHub
parent 293f87b83c
commit d499dc9103
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -8,6 +8,12 @@ The end goal of this tool:
- Build guidelines for code layout and format
- Automate the process to help streamline code reviews
## 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.
## Supported Linters
Developers on **GitHub** can call the **GitHub Action** to lint their code base with the following list of linters:
| *Language* | *Linter* |