Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Render the submodule headers as Markdown headers? #64

Open
asmeurer opened this issue Apr 25, 2019 · 1 comment
Open

Render the submodule headers as Markdown headers? #64

asmeurer opened this issue Apr 25, 2019 · 1 comment

Comments

@asmeurer
Copy link
Member

The release notes may look better if instead of formatting it like

  • core
    • change 1
    • change 2
  • solvers
    • change 1
    • change 2
* core
  * change 1
  * change 2
* solvers
  * change 1
  * change 2

we instead used Markdown headers, like

core

  • change 1
  • change 2

solvers

  • change 1
  • change 2
#### core
* change 1
* change 2
#### solvers
* change 1
* change 2

It may also be easier for people to write release notes in this format, al they won't have to deal with nested bullets.

Finally, this would allow linking to the notes for a specific submodule, since every Markdown header gets an anchor.

Level 4 headers may be better level 3. Level 4 renders the same as just bold text, but with an anchor.

@asmeurer
Copy link
Member Author

Although as for people writing the notes like this in the PR template, they would probably get confused by the header level, and write notes like

core

  • change 1

solvers

  • change 2

So that may not be a great idea.

@asmeurer asmeurer changed the title Render the submodule headers as Markdown headers Render the submodule headers as Markdown headers? Apr 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant