Would be nice to know what violations are found.

thehanimo / pr-title-checker

An action to automatically check if pull request titles conform to Contribution Guidelines

MIT License

109 stars 36 forks source link

Would be nice to know what violations are found. #30

Open jagthedrummer opened 2 years ago

jagthedrummer commented 2 years ago

Currently this action only says "you got something wrong" and it leaves it up to you to figure out what. It would nice if it would report what part of the spec it's complaining about.

Like if the PR title is disable a flaky test it would be nice if the action somewhere listed that it's in violation because it's missing the <type>: prefix instead of leaving it up to the user to guess about what's not right.

thehanimo commented 2 years ago

The way the check is structured, in general, is to see if the title matches at least one template out of the many specified (via regex and/or prefixes). A failing test indicates that the current title does not match any valid template. I don't see how we could give a suggestion here? I do like the idea but the only feedback I can think of is listing out all valid templates and then say that the current one does not match any of them.

andrepaschoal commented 3 months ago

Folks, I was wondering if a custom message in the output would do the job. e.g.

"Please check the docs at http://mydocs.com/pr-title-conventions"
"Here are some valid titles: 123-abcd-xyz, [123] abcd-xyz"

Not enough magical as it demands some glue work, but perhaps that's all that's needed 🤷‍♂️