Which changes are non-notable? #524
Replies: 3 comments
-
My thoughts are it should be kept open-ended for each project to decide what is or isn't notable. For example, fixing a typo in a comment is almost always non-notable. But, increasing performance may or may not be notable, depending on how much of an improvement was made. I don't think |
Beta Was this translation helpful? Give feedback.
-
I agree with @Archmonger, the criteria for what is a notable change and what is not shouldn't be set in stone. However, this criteria could be included as guidelines (so developers have an idea of when to add to the changelog). As for the second question that @jeremykohn posed, I'm not that experienced with managing changelogs, but I feel that just adding them to git commit logs would be fine, along with a "fixed minor issues" in the release notes if the developer really wants to. |
Beta Was this translation helpful? Give feedback.
-
If a changelog is "a curated, chronologically ordered list of notable changes" (emphasis added), that implies some changes are not notable and therefore should not be included.
So, two questions:
(1) What types of changes to a coding project are non-notable?
Some possibilities:
Generally revising code to
Revising comments
Adding, removing, or changing
Changing (if not significant for code execution)
Adding/removing empty or unused
Changing the sequence of
Assuming none of those changes will significantly affect the code's final output or end result.
And a related question:
(2) If certain changes are not listed in a changelog, where should they be listed (if anywhere)?
Beta Was this translation helpful? Give feedback.
All reactions