search

nedbat / scriv

Changelog management tool
https://scriv.readthedocs.io
Apache License 2.0
256 stars 28 forks source link

All default templates from file. #98

Closed DonalChilde closed 11 months ago

DonalChilde commented 1 year ago

I thought it would be useful to have all the templates exist in a single place, allowing an easy starting point for users to customize their own templates. It was surprisingly simple to do, which is good, as simple is my maximum capacity.

All tests run, except for some surrounding ghrel stuff. And to be honest, those same tests didn't run against main on my machine. Maybe an error in my setup?

At any rate, I am interested in your thoughts. This is my first attempt at contributing to a project, so if there is anything you were expecting that I am missing, please let me know.

nedbat commented 11 months ago

@DonalChilde Sorry I've let this sit for so long! This is an interesting idea, but I'm not sure it will be easier for people to modify the defaults this way. As it is, the one-line defaults are in the docs, and people can copy them from there and adjust as needed. Putting them into scriv-shipped files makes them harder to find, I think.

SpecLad commented 11 months ago

FWIW, the default entry_title_template is not shown in the docs (as code, I mean; it's explained in English). It would be nice to have it there.

nedbat commented 11 months ago

Good point. I've added the explicit default in commit 5ecd5be6777abd6583aa576242369670d40c6c2d.