Skip to content

Latest commit

 

History

History
14 lines (8 loc) · 1.08 KB

CHANGELOG.md

File metadata and controls

14 lines (8 loc) · 1.08 KB

Antwerp UI Angular - changelog guidelines

All notable changes to this project will be documented in a CHANGELOG.md file. A changelog makes it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.

Conventions

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Guidelines

Pull Requests

Every PR must include a relevant entry in the unreleased section of the changelog if targeting master (if an entry is needed for the code). This helps us ensure the person most familiar with the changes is helping to write the changelog while it's still fresh instead of trying to go back in time later. It also shortens our release process and helps us decide when it makes sense to do a release. Finally, it gives our users and team members a chance to see what we've been working on between releases without having to check the commit logs which are written specifically with the maintainers in mind.