From 3b5df7dfd05426b6997a639da5bc790d1199c937 Mon Sep 17 00:00:00 2001 From: Anmol202005 Date: Thu, 3 Jul 2025 01:16:04 +0530 Subject: [PATCH] Issue #2: updated README.md --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 14f3c02..6501edf 100644 --- a/README.md +++ b/README.md @@ -34,10 +34,11 @@ _No checks analyzed yet_ ### Coding -| Status | Check | Recipe | Coverage Notes | -|--------|--------------------------------------------------------------------------------------------------------------------|--------|------------------------------------------------------------------------------------------| -| 🟢 | [`FinalLocalVariable`](https://checkstyle.sourceforge.io/checks/coding/finallocalvariable.html#FinalLocalVariable) | `TBD` | | -| 🔴 | [`MagicNumber`](https://checkstyle.sourceforge.io/checks/coding/magicnumber.html#MagicNumber) | | it requires contextual understanding to replace literals with meaningful named constants | +| Status | Check | Recipe | Coverage Notes | +|--------|------------------------------------------------------------------------------------------------------------------------|--------|------------------------------------------------------------------------------------------| +| 🟢 | [`FinalLocalVariable`](https://checkstyle.sourceforge.io/checks/coding/finallocalvariable.html#FinalLocalVariable) | `TBD` | | +| 🔴 | [`MagicNumber`](https://checkstyle.sourceforge.io/checks/coding/magicnumber.html#MagicNumber) | | it requires contextual understanding to replace literals with meaningful named constants | +| 🟢 | [`UnusedLocalVariable `](https://checkstyle.sourceforge.io/checks/coding/unusedlocalvariable.html#UnusedLocalVariable) | `TBD` | | ### Headers @@ -81,7 +82,10 @@ _No checks analyzed yet_ ### Naming Conventions -_No checks analyzed yet_ +| Status | Check | Recipe | Coverage Notes | +|--------|--------------------------------------------------------------------------------------------------------------------------------------|---------|--------------------------------------------------------------------------------------| +| 🔴 | [`AbbreviationAsWordInName`](https://checkstyle.sourceforge.io/checks/naming/abbreviationaswordinname.html#AbbreviationAsWordInName) | | Requires semantic understanding of abbreviations and context | +| 🟡 | [`AbstractClassName`](https://checkstyle.sourceforge.io/checks/naming/abstractclassname.html#AbstractClassName) | `TBD` | Partially covered by renaming abstract class names to match the configured pattern. | ### Regexp