commitlint icon indicating copy to clipboard operation
commitlint copied to clipboard

add troubleshoot on documentation and some lint minor refactors

Open marcalexiei opened this issue 1 year ago • 0 comments

Description

Closes #3894.

I added a new section in the documentation with the step to troubleshoot error similar to the one described on #3894.

I also made two additional changes:

  • I changed the error message to be more simple IMHO.
  • I used RuleConfigSeverity enum to compute outcome warnings and errors. (The enum was already imported)

Motivation and Context

#3894

Usage examples

N/A

How Has This Been Tested?

yarn test

Types of changes

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • [x] My change requires a change to the documentation.
  • [x] I have updated the documentation accordingly.
  • [x] I have added tests to cover my changes.
  • [x] All new and existing tests passed.

marcalexiei avatar Feb 25 '24 16:02 marcalexiei