gitupdate icon indicating copy to clipboard operation
gitupdate copied to clipboard

Documentation should include a sample commit message

Open nmusolino opened this issue 4 years ago • 2 comments

It would be very helpful if the main README.md contained an example of a commit message created by this tool.

nmusolino avatar Jun 10 '20 17:06 nmusolino

It links to https://github.com/nikitavoloboev/knowledge/commits/master which gives an example of the commit messages. Or you want something else?

nikitavoloboev avatar Jun 10 '20 18:06 nikitavoloboev

Yes, I’m suggesting that you “inline” an example, e.g. the output from git log -n1, in a code block.

I came to this repo from a Hacker News comment and the single biggest question in my mind was, What do these commits look like?

Additionally, Github doesn’t really make it easy to see multi-line commit messages.

nmusolino avatar Jun 10 '20 23:06 nmusolino