# Release notes

**URL:** https://discourse.kitware.com/t/release-notes/84
**Category:** Software Process
**Created:** [April 10, 2018, 5:11pm UTC](https://discourse.kitware.com/t/release-notes/84 "2018-04-10T17:11:23Z")
**Posts on this page:** 4
**Page:** 1

<div class="post-metadata">

### Author: ![dcthomp](https://discourse.kitware.com/user_avatar/discourse.kitware.com/dcthomp/32/10_2.png) [@dcthomp](https://discourse.kitware.com/u/dcthomp)
#### Post date: [April 10, 2018, 5:11pm UTC](https://discourse.kitware.com/t/release-notes/84/1 "2018-04-10T17:11:25Z")

</div>

A while back we had discussed adopting ParaView’s practice of adding a markdown changelog to each significant merge request (MR).

- I’m starting that with [SMTK MR 1096](https://gitlab.kitware.com/cmb/smtk/merge_requests/1096), which adds a note to the (new) `doc/release/notes` directory.
- There is an example in `doc/release/notes` that you can use as a template.
- Whoever performs a release of SMTK should erase all the files in `doc/release/notes`, organizing their content into a file named `doc/release/announcement.md`. Any previous content in `doc/release/announcement.md` should be discarded at each major revision; the git history may be used to examine it if necessary.
- ParaView’s repo adds a reminder to the “Do: check” results if it doesn’t find an addition to the release note directory inside a MR… can we enable that for SMTK or do we need to wait for Ben to return?

---

<div class="post-metadata">

### Author: ![Haocheng\_Liu](https://discourse.kitware.com/user_avatar/discourse.kitware.com/haocheng_liu/32/36_2.png) [@Haocheng\_Liu](https://discourse.kitware.com/u/Haocheng_Liu)
#### Post date: [April 10, 2018, 6:27pm UTC](https://discourse.kitware.com/t/release-notes/84/2 "2018-04-10T18:27:56Z")

</div>

I asked Shawn and he told me that it’s a Brad King’s question (Should be pretty simple to enable the reminder). I would ask Brad during lunch tomorrow.

---

<div class="post-metadata">

### Author: ![ben.boeckel](https://discourse.kitware.com/letter_avatar_proxy/v4/letter/b/ea5d25/32.png) [@ben.boeckel](https://discourse.kitware.com/u/ben.boeckel)
#### Post date: [September 14, 2018, 9:04pm UTC](https://discourse.kitware.com/t/release-notes/84/3 "2018-09-14T21:04:16Z")

</div>

Is this still wanted?

---

<div class="post-metadata">

### Author: ![tj.corona](https://discourse.kitware.com/user_avatar/discourse.kitware.com/tj.corona/32/35_2.png) [@tj.corona](https://discourse.kitware.com/u/tj.corona)
#### Post date: [September 14, 2018, 9:28pm UTC](https://discourse.kitware.com/t/release-notes/84/4 "2018-09-14T21:28:19Z")

</div>

It has already been implemented.
