search

saschagrunert / git-journal

The Git Commit Message and Changelog Generation Framework :book:
MIT License
611 stars 18 forks source link

Markdown output appears to not render nicely on Github #734

Open nuxeh opened 3 years ago

nuxeh commented 3 years ago

e.g.:

# Unreleased (2020-12-08):
- [Added] buffering of input data from a pipe (5a57cde)
    Alternative input data can now be provided by piping it to the built
    binary implementing the Aoc stuct.
- [Added] `git-journal` configuration (161b1dd)
- [Added] CLI parsing for input file to crate struct (bc15e92)
    This allows an alternative input file to be used rather than fetched
    input, useful for testing, or modifying the input.

While this seems like nice compact markdown, the description paragraphs get rendered in the same line as the change heading, something like this:

Screenshot from 2020-12-08 16-15-26

saschagrunert commented 3 years ago

Hey @nuxeh, thank you for providing the issue! Do you mind opening a PR for that fix? We might change it to something like:

- **Added:** Some feature

WDYT?

nuxeh commented 3 years ago

Sure thing, I'm just not sure about how to integrate such a change, so what do you think would be the best way trigger this new type of output? A command line option, in the configuration? I think either could work, potentially.

But yes, agree on the format, however I'd also propose adding nested bullets to preserve the long descriptions as separate paragraphs, rather than being merged into the main change heading. And as a small thing, i think I prefer it slightly without the : after the tag. Maybe something like this:

# Unreleased (2020-12-08):

- **Added** buffering of input data from a pipe (5a57cde)
    - Alternative input data can now be provided by piping it to the built
      binary implementing the Aoc stuct.
- **Added** `git-journal` configuration (161b1dd)
- **Added** CLI parsing for input file to crate struct (bc15e92)
    - This allows an alternative input file to be used rather than fetched
      input, useful for testing, or modifying the input.

Which looks like:

Unreleased (2020-12-08):

saschagrunert commented 3 years ago

Oh yeah the format makes sense to me. Yes making it an CLI option would probably a good move forward, not sure how to name such a flag.

nuxeh commented 3 years ago

Would --github work?

saschagrunert commented 3 years ago

Would --github work?

Yeah I think it would. 👍