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

Change section headers to be less prominent #113

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

skorokithakis
Copy link
Contributor

I have changed the section headers from an h3 to just bold, as I think there is too much visual clutter in the Markdown template, as most elements are headers. This way looks a bit better rendered.

@codecov
Copy link

codecov bot commented Mar 19, 2019

Codecov Report

Merging #113 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #113   +/-   ##
=======================================
  Coverage   88.45%   88.45%           
=======================================
  Files           2        2           
  Lines         840      840           
  Branches      168      168           
=======================================
  Hits          743      743           
  Misses         58       58           
  Partials       39       39

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 95fe8d5...dacfd6c. Read the comment docs.

@vaab
Copy link
Owner

vaab commented Mar 19, 2019

hmm, thanks for your interest. I'm not inclined into integrating such change in gitchangelog because it seems you are changing semantic marks to tinker presentation issues. This is clearly a section title and I don't feel it is the right solution to mark it as important (the semantics of double star inclosure) in a lone paragraph.

It might be beautiful in your current theme, but won't probably in other theme... additionally this makes the generated changelog to loose readibility both in ASCII and by machines : for instance, automatic links to section are not anymore possible (and inclusion in table of contents).

I hope you understand my concerns.

In an other hand, I could consider favorably a request to tune down the semantic importance of these sections and use for instance a definition list... but this will need to be thought through and is probably not of primary concern.

Of course, this type of modification is perfectly understandable on your personal level to suit your particular needs and should be encouraged. I feel that it is still not yet enough streamlined.

If you don't mind, I'm happy to keep this PR open as I definitively want to come back later to check out these 2 alternatives I've just mentioned (changing the semantic level of sections and ensure that personal modification to template are streamlined). But don't expect your PR to be included as-is, nor me checking back this soon.

@skorokithakis
Copy link
Contributor Author

Sure, that's fine, thanks. The underlying problem that made me come here is that I can't easily change the template myself. It would be great if I could just include the template in the config file as a string (to avoid creating new files), but that's currently not possible (and I don't think it's possible to use any other template at all?).

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

Successfully merging this pull request may close these issues.

2 participants