pr-template: instruction about updating changelog #1205
Conversation
| @@ -1,6 +1,10 @@ | |||
| <!-- | |||
| Work-in-progress PRs are welcome as a way to get early feedback - just prefix | |||
| the title with [WIP]. | |||
|
|
|||
| Add the change in the changelog (except for test changes and docs updates). | |||
| Please edit CHANGELOG.md and add the change under the appropriate category (NEW | |||
There was a problem hiding this comment.
the changelog currently only has IMPROVEMENTS, not all three of these. seems to me like KISS would dictate that we just have IMPROVEMENTS and BUG FIXES as sections, but if you're modeling this after some other changelog that seems particularly effective, i'm happy to defer.
There was a problem hiding this comment.
I think we would have new features when the new status is implemented. So, we can use NEW FEATURES then. Let's keep it 🙂
There was a problem hiding this comment.
what rule would you apply to distinguish between an improvement and a feature?
There was a problem hiding this comment.
NEW FEATURE = new subcommands, flags, importer support
IMPROVEMENTS = enhancement on existing features and behavior
I see NEW FEATURE as a special section that would be at the top, which could be used to highlight important changes that affect the users. This could be a new way to do something, support for something new or a breaking change to some existing behavior. And IMPROVEMENTS for the rest of the things, that a normal user need not care much.
There was a problem hiding this comment.
i still think we'll have some difficulty cleanly applying that rule to cleanly delineate between the two, but as long as we're looking at "NEW FEATURE" as a special section that we use to highlight things, i think it's probably OK.
|
Seems like #1221 fixes this. |
darkowlzz
force-pushed
the
pr-template-changelog
branch
from
04b5e1f
to
2e51ae2
Compare
|
Rebased! |
What does this do / why do we need it?
Adds instructions about updating changelog in the PR template.
What should your reviewer look out for in this PR?
The instruction message and format.
Do you need help or clarification on anything?
Is this good or can it be improved?