|
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.
|