Skip to content

Extend Examples in README

I spent a lot of time today finding out that your images already provide a solution for me, which wasn't clear from the README. In particular, I wanted to create a report that I could import into GitLab's Code Quality feature. Since that already works out of the box, here's a suggestion for the README:

  • Add a link to ESLint.
  • Remove the stage field, rather use needs: [] to signal that it can run independently of everything else. It can, or?
  • Fix the reference to --no-eslintrc. Current ESLint uses --no-config-lookup instead.
  • Provide an additional example with a Code Quality integration.
  • Fix dead link to https://gitlab.com/pipeline-components/eslint/-/blob/main/CONTRIBUTING.md.

Apart from the last one, I have a clear idea what to do and will follow up with a merge request.

Edited by Ulrich Eckhardt