Merge pull request #84 from github/document-behavior

docs: clarify action behavior in README
This commit is contained in:
Zack Koppert 2020-05-05 09:48:08 -07:00 committed by GitHub
commit 92a5bcfccc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

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