[FOLIO-726] Improve guidance around what to include in news in release documentation Created: 18/Jul/17  Updated: 18/Jan/19

Status: Open
Project: FOLIO
Components: Documentation
Affects versions: None
Fix versions: None

Type: Task Priority: P3
Reporter: Marc Johnson Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: sprint19, team2
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to UIU-133 Support circulation interface 2.0 Closed
Sprint:
Development Team: Core: Platform

 Description   

In order for release announcements to be more useful to consumers of a module it could be useful to improve the guidance around what changes to include in (and how to present) the news.md release information.

Scope:

  • Include changes to interface dependencies (noting that major interface dependency changes also need major implementation version change)
  • Include changes to interface provision (noting that major changes to already provided interfaces also need major implementation version change)
  • Include explicit information about what has changed in the interface(s) being provided
  • When referring to particular properties in a schema, use code formatting in markdown to make the name of the property unambiguous e.g. Added required property `action` to loan (see https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code for more information).

Follows useful feedback from Mike Taylor for improving the understanding of release information.


Generated at Thu Feb 08 23:07:53 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.