Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Every commit must include at least an Epic ref, an Issue ref or a Docs note.

If the commit does not require a release note and there is no Epic ref or Issue ref, use Docs note: None.

How do I choose which one to include?

...

Whereas the “Release note” text explains what changed in the product, the “Docs note” text should explain why the change was made. What motivated the change? Was the change made for Postgres compatibility or to support a specific third-party tool? Was the change made to improve the usability of a specific feature? Please provide enough detail for writers to understand the context for the change.

Note that when When there is a link to an epic, that epic answers this why question. The “Docs note” is required only in cases where an epic link or an issue link doesn’t clarify the context for the change.

When the commit does not require a release note and there is no Epic ref or Issue ref, use Docs note: None.

What are some examples of Docs notes?

...