This all looks cool. I have two questions about the process though:

1) I am afraid it will be difficult to expect the contributors (and even
long time committers) to remember that we should add it (and to know when
to add them and when not) - do we plan to have some rules for that that we
can communicate to contributors (and how?).
2) also I am a bit afraid that if we don't do any kind of enforcement from
the beginning, people will not add it and I would rather get the CI to
remind them about that rather than reviewers (especially if we have no
clear rules about 1)

Just for the reference for `pip` - they have both quite comprehensive
documentation
https://pip.pypa.io/en/stable/development/contributing/#news-entries as
well as automation about trivial changes having to create ".trivial" empty
newsfragment  to mark that .newsfragment is not needed for this change.

Don't you think we should have it from day one as well when we introduce it
?  I am afraid if we don't, it might create some confusion and a bit of
mess taking into account that we might have two sources of changelog (NEWS,
commit messages).
Maybe TP will be able to share his experiences on how it was introduced in
pip and some learnings from it ?

BTW. I am happy to help with automating that of course :).

J.



On Wed, Mar 9, 2022 at 8:13 PM Jed Cunningham <[email protected]>
wrote:

> Thanks Kaxil!
>
> Here is a specific example from pip, a bugfix in 22.0.3 (note the file
> added to `news`):
> https://github.com/pypa/pip/pull/10869/files
>
> Which is moved from that news file to NEWS.rst here during release (note
> the `news` deletions):
> https://github.com/pypa/pip/commit/44018de50cafba25445a225c1a1986d6312e1ef3
>
> And ultimately ends up here:
> https://pip.pypa.io/en/stable/news/#v22-0-3
>

Reply via email to