Updated Changelog format (markdown)

Alex Grin 2017-07-24 16:43:14 -04:00
parent f4ca51ae1d
commit c15f199d34
2 changed files with 31 additions and 26 deletions

31
Changelog-Format.md Normal file

@ -0,0 +1,31 @@
## The Changelog
This is the suggested format for entries in [CHANGELOG.md](https://github.com/lbryio/lbry/blob/master/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 :hankey:.
For each entry, include links to the relevant issue(s) at the end.
## The Format
### Security
* Fixed \<issue description> (\<link>), impact <[vulnerability score](https://www.first.org/cvss/calculator/3.0)>
*
### 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>)
*

@ -1,26 +0,0 @@
#### Sometimes there will be fixes that don't have an issue, in such cases please be as descriptive as possible.
### Security
* Fixed \<issue link>, impact <[vulnerability score](https://www.first.org/cvss/calculator/3.0)>
*
### Fixed
* Fixed \<issue link>
*
### Deprecated
* Deprecated `<name>` from `<module path>`
*
### Changed
* Changed `<item changed>` to \[\<verb>] \<new behavior> instead of \<old behavior>
*
### Added
* Added `<item added>` to `<context (API commands, file path, etc)>`
*
### Removed
* Removed `<item or file>` from `<module or directory>`
*