Skip to content

Dev

LOKESH MANCHALA requested to merge dev into main

What does this MR do?

Fixes unclear error messages in the GitLab compliance checker suggestions. Previously, missing files were displayed with confusing variable names like "vscode_extensions_exists" instead of clear descriptions. This MR improves user experience by showing descriptive error messages and fixes several grammar issues.

Root Cause

The get_suggestions_for_missing_items function was using internal variable names as display labels instead of user-friendly descriptions.

Steps to Reproduce (Before Fix)

Run the GitLab compliance checker on a project missing VSCode configuration files Observe the suggestions section showing confusing messages like:

" vscode_extensions_exists — Add a .vscode/extensions.json file..." " vscode_launch_exists — Add a .vscode/launch.json file..."

Notice grammar errors like "user have a project" and ".vscode/settings.json have Ruff"

How the Fix Works

Updated suggestion list structure: Changed from 2-tuple to 3-tuple format (key, display_name, suggestion_text) to provide clear, user-friendly labels Fixed key mapping: Removed the problematic updated_report logic that was changing keys between compliance checks and suggestions

How to Test

Run the compliance checker on a project missing several configuration files Verify that the suggestions section now shows clear messages like:

" .vscode/extensions.json missing — Add a .vscode/extensions.json file..." " Ruff not configured in .vscode/settings.json — Ensure .vscode/settings.json includes Ruff..."

Check that all grammar issues are resolved in both the compliance summary and suggestions Verify that the documentation section properly maps to missing configuration files

Screenshots or Recordings (if applicable)

Before After
Screenshot_From_2025-07-31_14-21-03 Screenshot_From_2025-07-31_14-20-14

Checklist

  • The bug is fixed and no longer reproducible
  • Related tests were updated or added
  • No unrelated changes are included in this MR
  • Documentation (if relevant) has been updated

Merge request reports

Loading