SKILL.md
Guide through adding a new reporter named $ARGUMENTS to MegaLinter.
Steps:
- Create the class in
megalinter/reporters/<Name>Reporter.pyextendingmegalinter.Reporter - Implement required methods:
- manageactivation() — check env var like <NAME>REPORTER=true to enable/disable - producereport() — generate the report output - Optionally: initialize(), addreport_item()
- Register the reporter — check how existing reporters are discovered and loaded in
megalinter/MegaLinter.py - Reference patterns from existing reporters:
- Simple output: ConsoleReporter.py, TapReporter.py - CI integration: GithubCommentReporter.py, GitlabCommentReporter.py - File output: JsonReporter.py, SarifReporter.py - External service: ApiReporter.py, EmailReporter.py
- Update documentation — add a docs page describing configuration
- Update
CHANGELOG.mdin the repository root (not docs/) — add one line under Reporters in the beta section:
``text - Add <ReporterName>: <what CI system or output format it supports, one sentence> ``
- Branch naming: use
user/add-<reporter-name>-reporter