commit-message checker should link to a dedicated page explaining what went wrong

[not-an-aardvark]

For example, if a user's PR title is too long, the status check could link to something like this:

https://eslint.org/commit-message-statuses?reason=too-long&type=pr-title

Then some JavaScript on that page would render a specific description of what the user needs to fix. This could make it easier for the user to figure out specifically what is wrong with their PR.

[not-an-aardvark]

As an alternative to this, we could also look into making the plugin use GitHub Checks to report a more detailed status message.

[anikethsaha]

I have thought about the implementation of this.

How about having error codes, many be using a combination of numbers eg : CM203 etc.

We can have them documented in main docs here and even in this docs.

like this

- CM203: commit message length is greater than 72
...

And in the plugins' code, we will create an array for the error codes and push the code in that, and while showing the final message, simply show that array using ,join .

so it would be like

Commit message doesn't follow guidelines, error codes : CM203, CM200 

Thoughts ?

[nzakas]

I’m not a fan of error codes — they are too far away from useful information to end users.

Given that we can modify the commit messages when we merge PRs, I’m not sure we need this level of checks.