lint/TEMPLATES/README.md

11 lines
547 B
Markdown
Raw Normal View History

2019-10-21 12:05:55 -04:00
# TEMPLATES
The files in this folder are template rules for the linters that will run
against your codebase. If you choose to copy these to your local repository in
the `.github/linters/` directory, they will be used at runtime. If rule files
are not present locally, the templates will be used by default.
2019-10-21 12:05:55 -04:00
The file(s) will be parsed at runtime on the local branch to load all rules
needed to run the **Super-Linter** **GitHub** Action. The **GitHub** Action will
inform the user via the **Checks API** on the status and success of the process.