-
Notifications
You must be signed in to change notification settings - Fork 753
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
Added a changelog. #1230
Added a changelog. #1230
Conversation
ec956b2
to
068aaf6
Compare
Pull Request Test Coverage Report for Build 1847
💛 - Coveralls |
Maybe leave open for discussion for a bit, but I'm all for this update :) |
CHANGELOG.md
Outdated
|
||
## Unreleased | ||
### Added | ||
- Added changelog in PR [#1230](https://github.com/Microsoft/BotFramework-Emulator/pull/1230) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should "tag" each change.
ex: [ui]
, [core]
, [build]
, etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So in the case of modifying something like the README
or this CHANGELOG
what sort of tag would we use? [docs]
? or [infrastructure]
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think docs
makes sense. This is based on https://www.npmjs.com/package/commitizen (which I'd like to introduce at some point), but we can discuss what those tags should be.
068aaf6
to
587280a
Compare
Addresses #1161
===
Follows the same format as Webchat's changelog.
So for example:
All of our current changes until we release v4.3 will go in the
Unreleased
section. Then, once 4.3 is released, we copy all the changes fromUnreleased
into the4.3.0
section and wipe out theUnreleased
section. Then the next set of changes will continue to be added toUnreleased
until we decide to cut another version (v4.3.1, or v4.4.0, etc.).Possible change categories under each section include:
I'm completely open to discussion about this format. Reference docs here.