Dear all, this is my first post here, so: Hello to everyone. (I will decide in the next weeks if I can help you with this project. So far, this is just an initial contact.) I'ld recommend a changelog for the app that is distributed with new releases. This is a short summary for the end user in my opinion. Of course, a date for each release does not hurt, too. ;) The repository related changes are changes to the development mode in my opinion. Either one is defining some kind of code of conduct / coding guidelines in another document, a wiki or somewhere else or it is a proven process forced by the active developers (and resulting in code documentation all over the project). I wouldn't try to mix that in a single "changelog" file. Best, Lutz
c.buhtz@posteo.jp hat am 11.09.2022 15:53 CEST geschrieben:
On 2022-09-11 13:19 "J. A." <python@altfeld-im.de> wrote:
Only one question arised to me:
Shall the CHANGELOG document the changes a) of BiT as App b) or of the repo
Damn! We on a quit high level here! :D I learn so much. ;)
I have no opinion about that question. But it reminds me on some nerdy IT podcast I was listing to a discussion between two "professional" (payed) developers arguing about the difference between commit messages and changelog entries.
I can't remember or didn't understand a solution on that discussion.
But I would say that a) is something that could be described from the perspective of a user; a "user story". e.g. "BIT now can use rsync versions 3.2.4 and higher" And b) is more developer/technical; e.g. "Use '-s' rsync-switch to activate the modern and recommended way of argument protection in all rsync versions starting with 2.4 and higher".
I do not have a final opinion about that. If anyone does more research on that and find articles about it please let me know. _______________________________________________ Bit-dev mailing list -- bit-dev@python.org To unsubscribe send an email to bit-dev-leave@python.org https://mail.python.org/mailman3/lists/bit-dev.python.org/ Member address: lutzl@mailbox.org