# Draft Release Template **URL:** \ **Category:** Templates\ **Created:** [6 June 2024 00:12 UTC](https://forum.access-hive.org.au/t/draft-release-template/2143 "2024-06-06T00:12:42Z")\ **Posts on this page:** 10\ **Page:** 1
**Author:** ![ben](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/ben/32/282_2.png) [@ben](https://forum.access-hive.org.au/u/ben)\ **Post date:** [6 June 2024 00:12 UTC](https://forum.access-hive.org.au/t/draft-release-template/2143/1 "2024-06-06T00:12:42Z")
To receive email notifications when a new release is announced, please [watch] this topic. * * * # PRODUCT NAME šŸš€ **Release** : N.N.N Short blurb or what the product is and the major changes in this release. ## How to use Refer to LINK TO USER GUIDE ## Features āœ… Feature 1 āœ… Feature 2 āœ… Feature 3 ## Limitations šŸ›‘ Limitation 1 šŸ›‘ Limitation 1 šŸ›‘ Limitation 1 ## Known Issues āš  Add any warnings as appropriate here, or delete. ## Credits ā­ Initial work @person1 @person2 ā­ More work @person1 @person3 ## Support Replies to this topic are disabled. If you have specific questions about **this release** [follow the guidelines for requesting support from ACCESS-NRI](https://forum.access-hive.org.au/t/access-help-and-support/908). If you have questions about #tagforthismodel create a topic in #Earth System and tag it with #tagforthismodel If you require assistance [follow the guidelines for requesting help](https://forum.access-hive.org.au/t/access-help-and-support/908). ## Resources - Link to docs - Link to GitHub etc. ---
**Author:** ![Aidan](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/aidan/32/42_2.png) [@Aidan](https://forum.access-hive.org.au/u/Aidan)\ **Post date:** [6 June 2024 01:09 UTC](https://forum.access-hive.org.au/t/draft-release-template/2143/2 "2024-06-06T01:09:58Z")
Iā€™d plump for a ā€œCreditsā€ section ---
**Author:** ![Aidan](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/aidan/32/42_2.png) [@Aidan](https://forum.access-hive.org.au/u/Aidan)\ **Post date:** [6 June 2024 01:13 UTC](https://forum.access-hive.org.au/t/draft-release-template/2143/3 "2024-06-06T01:13:33Z")
In the spirit of pedantry, I think Iā€™d prefer ā€œHow to useā€ to ā€œGetting startedā€. If someone is already using a released product and wants to update to the more recent version ā€œGetting startedā€ doesnā€™t seem as appropriate. This is a musing more than anything. Iā€™ve not even managed to convince myself, but thought it worth mentioning. ---
**Author:** ![Aidan](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/aidan/32/42_2.png) [@Aidan](https://forum.access-hive.org.au/u/Aidan)\ **Post date:** [6 June 2024 01:14 UTC](https://forum.access-hive.org.au/t/draft-release-template/2143/4 "2024-06-06T01:14:17Z")
In a similar vein, ā€œResourcesā€ instead of ā€œFurther Readingā€? ---
**Author:** ![anton](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/anton/32/1836_2.png) [@anton](https://forum.access-hive.org.au/u/anton)\ **Post date:** [8 July 2024 01:17 UTC](https://forum.access-hive.org.au/t/draft-release-template/2143/5 "2024-07-08T01:17:42Z")
Do we need a section for **Breaking Changes**? Do we need a section for Test Results ? (optimistic, I know!) Github links are good, but should we also have a gadi address (i.e. which module to use) I think the sections should be more explicit: i.e. - Limitations should have links to github issues and any known issues should be put into issues before the release is made - Link to github should be a link to the Github release ---
**Author:** ![Aidan](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/aidan/32/42_2.png) [@Aidan](https://forum.access-hive.org.au/u/Aidan)\ **Post date:** [22 August 2024 03:51 UTC](https://forum.access-hive.org.au/t/draft-release-template/2143/6 "2024-08-22T03:51:06Z")
Do we have a process for incorporating (or rejecting) suggested changes? Iā€™ve added ā€œKnown Issuesā€ heading above the warnings in my first use of the template, as I think it is important to at least imply this might be something we will fix at a later date. ---
**Author:** ![Aidan](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/aidan/32/42_2.png) [@Aidan](https://forum.access-hive.org.au/u/Aidan)\ **Post date:** [22 August 2024 04:05 UTC](https://forum.access-hive.org.au/t/draft-release-template/2143/7 "2024-08-22T04:05:59Z")
Definitely also need a boiler-plate ā€œHow to get supportā€ section. ---
**Author:** ![ben](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/ben/32/282_2.png) [@ben](https://forum.access-hive.org.au/u/ben)\ **Post date:** [27 August 2024 00:13 UTC](https://forum.access-hive.org.au/t/draft-release-template/2143/8 "2024-08-27T00:13:36Z")
Iā€™ve added some of the suggestions to the template - I think this will be somewhat organic and change slightly for the specific release. We can re-evaluate as time goes on. ---
**Author:** ![Aidan](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/aidan/32/42_2.png) [@Aidan](https://forum.access-hive.org.au/u/Aidan)\ **Post date:** [26 March 2025 07:15 UTC](https://forum.access-hive.org.au/t/draft-release-template/2143/9 "2025-03-26T07:15:37Z")
Iā€™ve modified to more closely reflect current usage. This includes adding a support section, changing the visibility of credits, and splitting the known issues and warnings. We can change back or modify as required. One formatting change was to use markdown titles. This has the advantage that it creates an anchor to that section so it can be linked to directly. ---
**Author:** ![Aidan](https://sea2.discourse-cdn.com/flex020/user_avatar/forum.access-hive.org.au/aidan/32/42_2.png) [@Aidan](https://forum.access-hive.org.au/u/Aidan)\ **Post date:** [5 June 2025 05:11 UTC](https://forum.access-hive.org.au/t/draft-release-template/2143/10 "2025-06-05T05:11:53Z")
I have reverted back to the version before the edits by @cbull, though I made a real hash of the and just ended up pasting in the text from the previous revision.