Every product team must add Release Notes as part of the documentation.
The following location must be used for tenant release notes: repo-name/docs/release-notes.md
We strongly encourage the use of below template to document content changes.
v1.0.0 (the version of openAPI Document that defines an API containing the change)
- Something new that was added or introduced like a documents or a services.
- Description of an improvement or a change.
- github issue that was fixed. Possible github issue link
- A persistent issue that's known and not fixed.
- An endpoint or a payload field regarded as obsolete and best avoided.