Loading...
 
Skip to main content

History: Commit Message

Source of version: 15 (current)

Copy to clipboard
A key part of a [https://gitlab.com/tikiwiki/tiki/-/merge_requests|merge request] is the explanation messages. It should make it easy for anyone to understand why this merge request was made.

!! Title
A one-liner with ((Commit Tags)). Always try to use proper English (US) to explain in a simple sentence what part (or feature) of Tiki the commit affects and please include space after the commit tags, for example:

{CODE()}
[ENH][UX] Control Panels: Improved the alignment of the check boxes
{CODE}

!! Description
Unless the title explains it all, add a description to help the community (and especially the developer who will merge it in) understand the purpose.

More details: 
# If this relates to a wish on dev.tiki.org, please add the link.
# Additionally, if this relates to a task on avan.tech, please add the {MOUSEOVER(label="short link")}The natural link is https://avan.tech/item65876-mpdf-generation-doesn-t-include-diagrams-if-only-local-casperjs-installed-but-service-to-export-images-from-draw-io-not-enabled but that could disclose confidential information, so please use https://avan.tech/item65876 instead.

Please note that thanks to ((doc:SEFURL)), any text after item65876 is just cosmetic (and used for the ((doc:Canonical)) URL.

{MOUSEOVER} in the description, like was done here:
* https://gitlab.com/tikiwiki/tiki/-/merge_requests/1051
avan.tech tasks are generally not visible to anonymous but many Tiki contributors have access, so it helps coordination. And folks who are wondering about a merge request can request access, and we'll share any non confidential. Ex.: context of bug can be useful to the community, but the client who sponsored it may not want public credit.

!! Related
* https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/
* An idea for the future: https://www.conventionalcommits.org/
Show PHP error messages