Created changelog format (markdown)

Jack Robison 2017-07-24 14:51:06 -04:00
parent 9ce40efbc7
commit 0392442b5a

27
changelog-format.md Normal file

@ -0,0 +1,27 @@
## Changelog format
#### 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>`
*