-
Notifications
You must be signed in to change notification settings - Fork 128
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
Add internal changes to changelog to improve visibility for developers and give credit #1673
Comments
+1 for including significant/noteworthy "invisible" changes. I think this would be a simple as changing the "Updating" section in
to something like
|
I like the idea of using a separate section for internal changes, so users can still look at the existing 3 knowing that they're actual changes to usage. @jameshadfield does this in Auspice already (e.g.). |
Agreed -- revising above suggestion to be from:
to something like:
|
Generally in favor of this, though I think we want to be consciously careful to not "overfill" the internal/development section and end up diluting/adding noise to the user-facing changes. I'd encourage people to think first about how internal/development changes manifest as user-facing changes, and then write about those instead of internal trivia. Regarding giving/surfacing credit, I'd think there are also other ways we can do that:
I'd also recommend the following reading to folks: |
When preparing release for 26.1.0, I noticed that there were quite a lot of nice internal changes like refactoring cram tests and using ngettext that don't end up in the changelog at all because we currently only include user facing changes there. (examples: #1658, #1596, #1647)
I think it would be good to allow inclusion of changelog entries (but not make them mandatory) for internal changes as well for two reasons:
We note who contributed changes in the changelog by adding the Github handle of the developer who contributed it, that's nice, but it seems unfair that we don't surface non-user-facing changes in the same way. @victorlin in particular has done a lot of great work that isn't credited in the changelog at all.
Other open source projects do include internal changes in their changelogs, we could adopt for example the "other" heading of pandas: https://pandas.pydata.org/docs/whatsnew/v2.1.2.html#other
The text was updated successfully, but these errors were encountered: