A key part of a 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:
[ENH][UX] Control Panels: Improved the alignment of the check boxes
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 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 SEFURL, any text after item65876 is just cosmetic (and used for the Canonical URL.
in the description, like was done here:
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.