Skip to content
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

Merged
merged 2 commits into from Jan 17, 2019

Conversation

Projects
None yet
4 participants
@tonyanziano
Copy link
Contributor

tonyanziano commented Jan 15, 2019

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 from Unreleased into the 4.3.0 section and wipe out the Unreleased section. Then the next set of changes will continue to be added to Unreleased until we decide to cut another version (v4.3.1, or v4.4.0, etc.).

Possible change categories under each section include:

  • Added
  • Changed
  • Removed
  • Fixed
  • Deprecated
  • Security

I'm completely open to discussion about this format. Reference docs here.

@tonyanziano tonyanziano force-pushed the toanzian/#1161-changelog branch from ec956b2 to 068aaf6 Jan 15, 2019

@coveralls

This comment has been minimized.

Copy link

coveralls commented Jan 15, 2019

Pull Request Test Coverage Report for Build 1847

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 61.998%

Totals Coverage Status
Change from base Build 1845: 0.0%
Covered Lines: 5517
Relevant Lines: 7983

💛 - Coveralls
@corinagum

This comment has been minimized.

Copy link
Member

corinagum commented Jan 15, 2019

Maybe leave open for discussion for a bit, but I'm all for this update :)


## Unreleased
### Added
- Added changelog in PR [#1230](https://github.com/Microsoft/BotFramework-Emulator/pull/1230)

This comment has been minimized.

@a-b-r-o-w-n

a-b-r-o-w-n Jan 15, 2019

Contributor

I think we should "tag" each change.

ex: [ui], [core], [build], etc.

This comment has been minimized.

@tonyanziano

tonyanziano Jan 15, 2019

Author Contributor

So in the case of modifying something like the README or this CHANGELOG what sort of tag would we use? [docs]? or [infrastructure]?

This comment has been minimized.

@a-b-r-o-w-n

a-b-r-o-w-n Jan 15, 2019

Contributor

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.

@tonyanziano tonyanziano force-pushed the toanzian/#1161-changelog branch from 068aaf6 to 587280a Jan 17, 2019

@a-b-r-o-w-n a-b-r-o-w-n merged commit 919f368 into master Jan 17, 2019

4 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 61.998%
Details
license/cla All CLA requirements met.

@a-b-r-o-w-n a-b-r-o-w-n deleted the toanzian/#1161-changelog branch Jan 17, 2019

@tonyanziano tonyanziano referenced this pull request Jan 17, 2019

Closed

Start a Change Log #1161

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.