Skip to content

feat:Add Mandatory File Compliance Checks (README.md & .gitignore)

SandhyaRani Bandaram requested to merge feature-compliance-checker into main

What does this MR do and why?

This Merge Request adds automatic validation for mandatory repository files — specifically README.md and .gitignore — across multiple GitLab project links.

In hackathons and intern evaluations, many repositories miss essential documentation and configuration files.
This feature ensures that every submitted project follows basic repository standards, improving code quality, documentation, and consistency.

Key Changes

  • Added automated checks for README.md presence
  • Added automated checks for .gitignore presence
  • Enabled batch validation for multiple GitLab repository links
  • Displays PASS / FAIL status per repository
  • Records results in final compliance output

References

  • GitLab Compliance Checker
  • Feature: Mandatory file compliance validation

Screenshots or screen recordings

Before After

No mandatory file validation

Screenshot from 2026-02-07 15-14-04.png

README.md & .gitignore validation added

WhatsApp Image 2026-02-07 at 14.52.40.jpeg

Manual checking required

Fully automated compliance checks

WhatsApp Image 2026-02-07 at 14.53.13.jpeg

How to set up and validate locally

  1. Clone the repository:

    git clone https://code.swecha.org/tools/gitlab-compliance-checker.git cd gitlab-compliance-checker

  2. Install dependencies:

    pip install -r requirements.txt

  3. Add multiple GitLab project links.

  4. Run the compliance checker:

    python main.py

  5. Verify output:

    • Each repository will show PASS / FAIL for:
      • README.md
      • .gitignore

MR acceptance checklist

README.md presence check added

.gitignore presence check added

Works for multiple repositories

No breaking changes

Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by SandhyaRani Bandaram

Merge request reports

Loading