CHANGELOG 101

CHANGELOG 101

How U CHANGLEOG?

For each version, what did you:

Follow semver MAJOR.MINOR.PATCH 2.14.1
Follow semver MAJOR.MINOR.PATCH (BREAK).(ADD).(FIX)
## 0.6.0

### Added
- a feature that was added

### Fixed
- a bug that was fixed

### Changed
- other, non-bug releated changes

### Removed
- remove functionality (could be BREAKING CHANGE) or files
    
WIP goes under #Unreleased

Mike's CHANGELOG entry:

## Unreleased

### Added
- a new capability related to a feature/enhancement

### Fixed
- a change related to a bug (by Mike)

## 2.23.1
...
    

Marvin's CHANGELOG entry:

## Unreleased

### Fixed
- a change related to a bug (by Marvin)

## 2.23.1
...
    

Merged entry:

## Unreleased

### Added
- a new capability related to a feature/enhancement

### Fixed
- a change related to a bug (by Mike)
- a change related to a bug (by Marvin)

## 2.23.1
...
    

Final (release) entry:

## 2.24.0

### Added
- a new capability related to a feature/enhancement

### Fixed
- a change related to a bug (by Mike)
- a change related to a bug (by Marvin)

## 2.23.1
...
    
Why U make me CHANGELOG?
Don't

fear the

monorepo
Many packages each with own changelog

Apps (opendata-*)

Addons (ember-*)

Bug fix / feature changes may touch multiple packages

Who's this for?

What questions are they trying to answer?

Typically lib consumers

Will release fix my bug? What will break if I upgrade? Are new features worth it?

1) Person doing release

What version number should I use for this package?

2) Person writing public changelog

In human terms, what's in this release?

3) Rest of our team

When did we add that feature / fix that bug?

Addon changelogs

for person doing release

App changelogs

for person writing public changelog

Examples

New Feature (app and addon code changes)

// addon CHANGELOG
## Unreleased

### Added
- added map card

## 0.5.0
...
    

New Feature (app and addon code changes)

// app CHANGELOG
## Unreleased

### Added
- added map card
 (https://esriarlington.tpondemand.com/entity/123456)

## 2.14.0
...
    

Bug Fix (addon code only)

// addon CHANGELOG
## Unreleased

### Fixed
- broken header nav styles in IE

## 0.5.0
...
    
Example

Bug Fix (addon code only)

// app CHANGELOG
## Unreleased

### Fixed
- broken header nav styles in IE
 (https://esriarlington.tpondemand.com/entity/123456)

## 2.14.0
...
Example
    

Bug Fix (app and addon code changes)

// addon CHANGELOG
## Unreleased

### Added
- add `user` option to `getEvents()`

## 0.5.0
...
    

Bug Fix (app and addon code changes)

// app CHANGELOG
## Unreleased

### Fixed
- bug showing current (instead of selected) user's events
 (https://esriarlington.tpondemand.com/entity/123456)

## 2.14.0
...
    
When U no CHANGELOG?
Bug / feature you're working on already has an entry in ## Unreleased
Why U no make do CHANGELOG?
Do we really have to do all that?
No, but...
Discuss