1 Changelog Format

Alex Grin edited this page 2017-07-24 16:43:14 -04:00

Table of Contents

• The Changelog
• The Format
• Security
• Fixed
• Deprecated
• Changed
• Added
• Removed

The Changelog

This is the suggested format for entries in CHANGELOG.md. The changelog is intended for our users and for developers outside of LBRY Inc. Please write the entries with that in mind. For example, "fixed that thing we talked about last week" is 💩.

For each entry, include links to the relevant issue(s) at the end.

The Format

Security

• Fixed <issue description> (<link>), impact <vulnerability score>

Fixed

• Fixed <issue description> (<link>)

Deprecated

• Deprecated <name> from <module path> (<link>)

Changed

• Changed <item changed> to [<verb>] <new behavior> instead of <old behavior> (<link>)

Added

• Added <item added> to <context (API commands, file path, etc)> (<link>)

Removed

• Removed <item or file> from <module or directory> (<link>)