release-notes/release-notes-spec

The goal of this repository is to work out an easy to use, human readable and machine processable schema for release notes.

release-notes-spec's Issues

Add support for references/links on modification level

As a maintainer i want to enrich release notes with issue references.

Acceptance Criteria

• the schema should support multiple, optional links on modification level
• links should be extendable in the future

Introduce new change set type: documentation

Documentation is an essential part of good software, thus it deserves an own area within a release statement.

I see 3 options for naming the new modification type:

• docs
• documentation
• or both with docs being alias of documentation

I like docs best. It is short and commonly used. documentation sound more official but is a quite long word. Having both options will bloat up the spec without much use.

Acceptance Criteria

• Add specification of new modification type for labeling documentation changes

Introduce new modification type "updated"

The new updated modification type targets dependency updates or text patches.

example

title: Example of new **updated**
releases:
- version: Next
  updated:
  - Upgrade to `[email protected]` from `v1.1.0`
  - Update COPYRIGHT year to 2017.
  - Add `@someone` to list of contributors.