docs(misc): minor improvements to:

- update documentation,
- add newly-clarified knowledge into pull-request policy
- help doc-writers/editors get things right the first time
This commit is contained in:
Victor Wheeler
2025-06-26 11:50:07 -06:00
committed by Gabor Kiss-Vamosi
parent b2bf3b7e34
commit 450a3902ec
3 changed files with 36 additions and 29 deletions
+2 -2
View File
@@ -96,9 +96,9 @@ commit. It's usually one word and can be chosen freely. For example
``<body>`` optional and can be used to describe the details of this
change.
``<footer>`` shall contain
``<footer>`` shall contain:
- the words "BREAKING CHANGE" if the changes break the API
- begin it with "BREAKING CHANGE" if the changes break the API;
- reference to the GitHub issue or Pull Request if applicable.
(See `Linking a pull rquest to an issue <https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests#linking-a-pull-request-to-an-issue>`__
for details.)