termui and cli removes Markdown headers

Timeline

Nick Tzaperas (nijotz) opened (edited)

In the termui and command line interface, there is the standard git message:

# Please enter the title and comment message. The first non-empty line will be
# used as the title. Lines starting with '#' will be ignored.
# An empty title aborts the operation.

I wasn't sure if Markdown was supported with this message, so I checked the docs. I didn't see anything about Markdown support in ticket descriptions, so I tried through experimentation. I made a bug using termui with code blocks, bolding, and headers. In webui, Markdown rendering worked, but the headers weren't there. So I put headers in using the webui. Back in the termui, the headers were there, but if I saved the ticket, they were removed. I'm assuming treated as comments per the message. I tried a backslash for escaping, but that didn't work. Putting a space in front of the hash marks for the headers worked.

Some things I think would be helpful:

  • Information about Markdown support in the docs. Maybe I missed it and in that case maybe improve discoverability.
  • Either:
    • Information about Markdown in the "git commit"-like message and how to put headers in or
    • Change the functionality of commit message and/or termui

I just started using git-bug, but I love the concept of this project and breaking away from (or at least bridging away from) vendor lock-in. I can help with any work around this issue.

Edit: I should say that I'm using v0.10.1