feat:Add Mandatory File Compliance Checks (README.md & .gitignore)
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.mdpresence - Added automated checks for
.gitignorepresence - 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 |
README.md & .gitignore validation added |
|
Manual checking required |
Fully automated compliance checks |
How to set up and validate locally
-
Clone the repository:
git clone https://code.swecha.org/tools/gitlab-compliance-checker.git cd gitlab-compliance-checker -
Install dependencies:
pip install -r requirements.txt -
Add multiple GitLab project links.
-
Run the compliance checker:
python main.py -
Verify output:
- Each repository will show PASS / FAIL for:
README.md.gitignore
- Each repository will show PASS / FAIL for:
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.


