mirror of
https://github.com/lvgl/lvgl.git
synced 2026-05-20 04:11:36 +08:00
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:
committed by
Gabor Kiss-Vamosi
parent
b2bf3b7e34
commit
450a3902ec
@@ -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.)
|
||||
|
||||
Reference in New Issue
Block a user