paritytech / bench-bot

ISC License
9 stars 19 forks source link

Do not dump the cargo invocation into the git commit title #76

Open pepyakin opened 2 years ago

pepyakin commented 2 years ago

A widely agreed convention is to keep commit titles to be within 50/72/80 characters. This practice originates from the days of Linux and LInus preferences^1. However, it does not stop there. Almost every tool in one way or another expects this and that includes GitHub.

However, when bench bot commits something it dumps the entire command line into the commit title, which is way over the limit. Here is an example rendering of this effect:

Screenshot 2021-12-20 at 13 31 11

Ideally, the bench bot only leaves a short summary of what this commit is. One potential idea is to reuse the command that lead to that commit: /benchmark runtime polkadot runtime_parachains::configuration. For custom invocations there should be something else though equally concise.

The full command line invocation, if actually needed, can go into the description part of the commit.