# Changelog

As of May 2018, this project includes a changelog.txt file which is intended to provide a summary of the development activity for each release of the project. This log is to be maintained in the style prescribed by keep a changelog (opens new window).

# Adding a Changelog Entry

When work on a Feature Branch or Hotfix has concluded a note should be added to the "Unreleased" section of the changelog. This note should be added prior to merging the feature into the staging branch. The Teamwork Task ID should be included in this note. Below is an example of the "Unreleased" section with some entries.

## [Unreleased]

### Added
- Sponsorship Acquisition Refugee Lifeline functionality (TW#19448018)
- Ecard Nomination campaign customizations (TW#14447018)

### Changed
- Updated docker images used in pipeline to circumvent build failures (TW#14480162).

# Adding a Release Entry

The changelog.txt file should be updated just prior to merging the latest Release Branch into master. A new subheader including the release version and date should be created (ex. ## [3.7.0] 2019-03-19 and all entries in the "Unreleased" section moved under this new header leaving the "Unreleased" section empty, like so:

## [Unreleased]

## [3.7.0] 2019-03-19
### Added
- Sponsorship Acquisition Refugee Lifeline functionality (TW#19448018)
- Ecard Nomination campaign customizations (TW#14447018)

### Changed
- Updated docker images used in pipeline to circumvent build failures (TW#14480162).