Conventions: Release notes file - Githubissues

Ferlab-Ste-Justine / development-standards

Team Development Standards

GNU Affero General Public License v3.0

0 stars 0 forks source link

Conventions: Release notes file #5

Open aalex opened 5 years ago

aalex commented 5 years ago

We need a file containing the release notes for each version, in each repository.

Contents of the proposal

Create a file called NEWS.md
Put the release notes for each new tag in that file, in anti-chronological order
Each entry should have the version number, and the date in ISO-8601 format as a title
List enhancements, bug fixes and refactoring there.
Use the Markdown format and file extension

Benefits

we can track what is new in each version (enhancements, bug fixes, refactoring, etc.)
we can track the versions

Inspiration

The GNU NEWS file: https://www.gnu.org/prep/standards/html_node/NEWS-File.html

aalex commented 5 years ago

@latch2112 Please take a look and comment, as needed.