cncf / cncf/toc

[Initiative]: Release Notes Best Practices

Open
#2,026 5 comments 0 reactions 0 assignees View on GitHub
kind/initiative needs-triage tag/operational-resilience
Dominant language
HTML
Stars
1.9k
Forks
724
Avg merge
6d 12h
Merged PRs (30d)
4

Description

### Name

Release Notes Best Practices

### Short description

Release Notes Best Practices

### Responsible group

TAG Operational Resilience

### Does the initiative belong to a subproject?

Yes

### Subproject name

_No response_

### Primary contact

N/A

### Additional contacts

n/a

### Initiative description

What are the best practices for Release Notes?
Adopters review release notes in order to determine whether to move to a new release. If the release notes do not give thorough information, adopters are unable to make an informed decision to move to a new release.

### Deliverable(s) or exit criteria

Document describing the best practices for a release document.

### Tracking document for meeting and progress

n/a

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.