Use details to advise how to fix

[JasonEtco]

Hey! This is really cool! I had a quick drive-by thought; with the GPG Probot App we've talked about how to fix a failed status. As in, what happens when someone commits without verifying their GPG key?

I think there's a similar situation with the commitlint-bot; if I commit a message that wouldn't pass, and the PR gets a ❌ , maybe you can use the Details pane to suggest ways to fix it. This way, it becomes a way for folks to learn on the spot and not be blocked by something they don't know how to do with Git.

[z0al]

@JasonEtco glad you like it!

I was thinking the same, I will do my best! Suggestions are welcome ;)

[z0al]

@JasonEtco I've been thinking for a while on this. As far I know these are the necessary information here:

• What is wrong with my messages
  I've already included the error messages from commitlint output.
• How should it look
  This is missing, I need to point them to somewhere where they can find the correct commit format, which I think should be written in the CONTRIBUTING file, or I can just point them to ConventionalCommits website.
• How to correct it (Git)
  This is also missing part, I think I need to include a link to this GitHub's help page

I think I may include the "How should it look" link as a target_url of the commit status

Also, I need to add a hint to "How to correct it" in the details comment so it will look like the following:

There were the following issues with this Pull Request

• Commit: 39962ce
  • ✖ message may not be empty
  • ✖ type may not be empty

You need to modify the commit messages to fix the above errors.

What do you think?

/cc @wzrdtales your feedback is welcomed

[z0al]

I have done some progress in #4 , please check out!