[go: up one dir, main page]

Skip to content

Markdown Support for Commit Messages

Problem to solve

Having markdown, gitlab flavored markdown support in commit messages would encourage the writing of more informative commit messages and make reviewing commits in the process of merge request reviews easier.

image

Intended users

Proposal

Markdown is used in several other places within gitlab. Passing a commit message through the markdown engine as the commit message web page is rendered might possibly take only a few lines of code.

Permissions and Security

This should require no additional security

Documentation

https://github.github.com/gfm/

Testing

As this is only connecting two already existing features

  • display of commit messages
  • markdown formatting

A minimal amount of additional testing should be necessary. Perhaps adding a recognition that a commit message containing markdown elements did indeed render to additional HTML.

What does success look like, and how can we measure that?

Commit messages with markdown provide a richer user experience for people reviewing commit messages in the process of code review.s

What is the type of buyer?

Developers who put effort into making informative commit messages.

Links / references

https://github.github.com/gfm/