Skip to content

Release notes template

Izaak "Zaak" Beekman edited this page Oct 9, 2019 · 2 revisions

Release notes template

General instructions

The following markdown can, and should be used as a template for new release' release notes. Please, DO NOT FORGET TO EDIT THE FOLLOWING PORTIONS:

  • Title and general notes (not present in template)
  • New Functionality sections
  • Bug fixes section
  • Add any additional pertinent information or sections
  • Update the URLs below <!-- these urls need updating each release -->

Unrendered, raw markdown template

Copy and paste this to get started on a new draft release:

<!-- generic, reusable header between releases -->

<div align="center">

[![Github Releases (by Asset)][downloads badge]][primary release asset] [![Build Status][tag build badge]][tag build link] [![license][license badge]][license link] [![Twitter URL][twitter badge]][do tweet]

</div>
New Functionality
-----------------

- add content here!

Bug Fixes
---------

- #1: Describe, in brief, the fixed issue
- Describe other fixes!

<!-- footer can be reused between releases -->

Installation
------------

Please see [the installation instructions] for more details on how to build and install this version of OpenCoarrays

---

<div align="center">

[![GitHub forks][forks badge]][do fork] [![GitHub stars][stars badge]][GH home] [![GitHub watchers][watchers badge]][GH home] [![Twitter URL][twitter badge]][do tweet]

</div>

<!-- these urls need updating each release -->

[primary release asset]: https://github.com/sourceryinstitute/OpenCoarrays/releases/download/2.7.0/OpenCoarrays-2.7.0.tar.gz
[downloads badge]: https://img.shields.io/github/downloads/sourceryinstitute/OpenCoarrays/2.7.0/opencoarrays-2.7.0.tar.gz.svg
[tag build badge]: https://travis-ci.org/sourceryinstitute/OpenCoarrays.svg?branch=2.7.0
<!-- UPDATE ME ONCE WE HAVE A BUILD (tag build link) -->
[tag build link]: https://travis-ci.org/sourceryinstitute/OpenCoarrays/builds/530987239
[license link]: https://github.com/sourceryinstitute/opencoarrays/blob/2.7.0/LICENSE
[do tweet]: https://twitter.com/intent/tweet?hashtags=HPC,Fortran,PGAS&related=wavebitsci,gnutools,DegenerateConic,HPCwire,HPC_Guru,hpcprogrammer,SciNetHPC,travisci&text=OpenCoarrays+2.7.0+released%21+with+full+support+for+GFortran+9.1,+improved+teams+support,+partial+support+for+DT+collectives+and+bug+fixes.&url=https%3A//github.com/sourceryinstitute/opencoarrays/releases/latest&via=zbeekman
[the installation instructions]: https://github.com/sourceryinstitute/opencoarrays/blob/2.7.0/INSTALL.md

<!-- these urls are static between releases -->

[license badge]: https://img.shields.io/badge/license-BSD%203--clause-blue.svg
[forks badge]: https://img.shields.io/github/forks/sourceryinstitute/opencoarrays.svg?style=social&label=Fork
[do fork]: https://github.com/sourceryinstitute/opencoarrays/fork
[stars badge]: https://img.shields.io/github/stars/sourceryinstitute/opencoarrays.svg?style=social&label=Star
[GH home]: https://github.com/sourceryinstitute/opencoarrays
[watchers badge]: https://img.shields.io/github/watchers/sourceryinstitute/opencoarrays.svg?style=social&label=Watch
[twitter badge]: https://img.shields.io/twitter/url/http/shields.io.svg?style=social
[Fortran 2018 Draft International Standard]: http://isotc.iso.org/livelink/livelink?func=ll&objId=19442438&objAction=Open&viewType=1
[Fortran 2018]: http://isotc.iso.org/livelink/livelink?func=ll&objId=19442438&objAction=Open&viewType=1

Rendered markdown:


Github Releases (by Asset) Build Status license Twitter URL

New Functionality

  • add content here!

Bug Fixes

  • #1: Describe, in brief, the fixed issue
  • Describe other fixes!

Installation

Please see the installation instructions for more details on how to build and install this version of OpenCoarrays


GitHub forks GitHub stars GitHub watchers Twitter URL