From 2413012b078f76760540eae092738bed89027dee Mon Sep 17 00:00:00 2001 From: Isaac Milarsky Date: Mon, 21 Oct 2024 14:24:13 -0500 Subject: [PATCH] Update README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index f2506141..a74ef5c5 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,15 @@ this question - `"project_name": "My Project",`. See the [cookiecutter docs](ht for more information. ## Repolinter + +Repolinter is a tool maintained by the [TODOGroup](https://todogroup.org/) for checking repositories for common open source issues, using pre-defined rulesets. This can be run stand-alone as a script, pre-commit in your IDE, or post-commit or within CI/CD systems! + +✔    =  Pass + +✖    =  Fail + +⚠  =  Warn + Tiers of level 1 thru 4 have repolinter.json file in their projects. Tier1 has detailed configuration of all the rules. All the other tiers extends their previous tiers and has only the `rule` and the `level` configuration. Sample commands to run with the given repolinter.json path: