Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 1.11 KB

README.md

File metadata and controls

51 lines (34 loc) · 1.11 KB
Raw

News files

This directory contains files describing changes since the previous release of SmiServices.

When a release is built, these files are automatically combined into the main CHANGELOG, and are then deleted.

File naming

News file names should be of the form

<pr#>-<type>.md

e.g.

1234-feature.md

Where type is one of

  • feature
  • change
  • bugfix
  • doc
  • removal
  • meta

Note Ensure that the file is named with the PR number, rather than any associated issue number.

Quick tip: You can get the most recent issue or PR number with the following one-liner. Then add one to determine the new one for your PR (so long as you're quick!)

$ curl -s "https://api.github.com/repos/smi/smiservices/issues?sort=created&direction=desc&per_page=1&page=1" | jq .[].number
702

The file should contain a short description of the patch as one or more lines of markdown, either as a top-level sentence

Fixed a foobar

or, if more detail is required, multiple lines formatted as a sub-list

Fixed a foobar

-   Requires users to change xyz