Difference between revisions of "Major release notes"
Jump to navigation
Jump to search
Line 42: | Line 42: | ||
− | ==ProjectName #.# - | + | ==ProjectName #.# - clean template== |
Released MM DD, YYYY. | Released MM DD, YYYY. |
Revision as of 16:04, 28 June 2017
Home > Release Notes > Major release notes template
IMPORTANT: only link to Redmine tickets in the public Archivematica project. If no public ticket exists, create a new ticket in the public Archivematica project and link it to the corresponding private ticket.
In the header, include any general notes about the release. For an example, see the Archivematica 1.6 Release Notes.
ProjectName #.#
Each section (Archivematica, Storage Service, FIDO) should follow the same pattern. Indicate the date of the release and include a short description about the scope of the release, especially if there are large changes.
Released MM DD, YYYY.
Archivematica #.# includes two new features, which are amazing. There are also several bug fixes to improve all sorts of things.
New features
List new features as bullet points, indicating the name of the sponsor or contributor (if available), a short description of the work, and links to the Redmine ticket and/or Github pull request.
- Sponsored (Name of sponsor) Short description of feature - (link to Redmine ticket, link to PR)
- Sponsored (GE Aviation) Bag ingest improvements - (#8309, PR191)
- Contributor (sevein) MCPServer: delete watchedDirectories/ duplicate - PR633
Bug fixes
List bug fixes as bullet points and include links to the Redmine ticket and Github pull request.
- Short description of the bug fix - (link to Redmine ticket, link to PR)
- Improvements to metadata.csv handling - (#7901, #8007, PR210)
New and upgraded tools
List which tool has been updated/upgraded and to which version.
- Tool updated to version #.#
- Elasticsearch updated to version 1.3
ProjectName #.# - clean template
Released MM DD, YYYY.
ProjectName #.# has one big, new, exciting feature and several small bug fixes.
New features
- Sponsored (Name of sponsor) Short description of feature (link to Redmine ticket, link to PR)
Bug fixes
- Short description of the bug fix - (link to Redmine ticket, link to PR)
New and upgraded tools
- Tool updated to version #.#