Versions Compared

Key

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

...

  • The first line must start with [Dd]ocs note:

  • It may span multiple lines

  • The Docs note text will be this line and every subsequent line until another section is reached (Release note: or Release justification:) or until the end of the commit description is reached.

  • The contents will describe why the commit was needed.

TODO:

  • add info on what type of information to include in the Docs note

  • add examples of docs notes

  • Note that the text does not end up in the documentation. It is used to inform the docs writers and it does not need to be short or concise like folks often do for release notes.