OpenParable
Skip to content
← Back to skills

Add Reporter

Development
add-reporter

Add Reporter is an Agent Skill for development published in the oxsecurity/megalinter repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Add a new output reporter to MegaLinter. Use when adding support for a new CI system or output format.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/oxsecurity/megalinter/blob/HEAD/.claude/skills/add-reporter/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/add-reporter, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Guide through adding a new reporter named $ARGUMENTS to MegaLinter.

Steps:

  1. Create the class in megalinter/reporters/<Name>Reporter.py extending megalinter.Reporter
  2. Implement required methods:
    • manage_activation() — check env var like <NAME>_REPORTER=true to enable/disable
    • produce_report() — generate the report output
    • Optionally: initialize(), add_report_item()
  3. Register the reporter — check how existing reporters are discovered and loaded in megalinter/MegaLinter.py
  4. 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
  5. Update documentation — add a docs page describing configuration
  6. Update CHANGELOG.md in the repository root (not docs/) — add one line under Reporters in the beta section:
    - Add <ReporterName>: <what CI system or output format it supports, one sentence>
    
  7. Branch naming: use user/add-<reporter-name>-reporter