Volker Braun writes:

> There is a somewhat painless approach to generating human-readable release 
> notes using https://github.com/hawkowl/towncrier. As far as the ticket 
> author is concerned, if you think that your ticket #12435 is of wider 
> interest and should be announced then all you'd have to do is add a file
>
> echo "Added the last twin prime" > newsfragments/12435.feature
>
> Note that the fragment filename starts with the ticket number, so it won't 
> conflict with other news fragments. Then, when making a new release, I 
> concatenate the fragments into NEWS.rst as, for example, 
> in https://github.com/hawkowl/towncrier/blob/master/NEWS.rst

I support the idea of providing users (and developers) with a NEWS file.
My first reaction to your suggestion with towncrier is to ask why it is
necessary to manually add news for a subset of tickets, instead of
auto-generating a NEWS file from all closed tickets.

Many tickets will be bug fixes or technical stuff, not very pleasant or
relevant to a user. But what if the "types" we have on tickets were more
meaningful, perhaps these could serve to divide such a NEWS file into
headings, e.g.

== New Features ==

24454: Added the last twin prime
....

== Enhancements ==

28042: A faster implementation of Q[x] factorisation
...

== Bug-fixes ==

25233: Fixed a crash when plotting.
...


Best,
Johan

-- 
You received this message because you are subscribed to the Google Groups 
"sage-devel" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sage-devel+unsubscr...@googlegroups.com.
To post to this group, send email to sage-devel@googlegroups.com.
Visit this group at https://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.

Reply via email to