Cédric Krier pushed to branch branch/default at Tryton / Website
Commits:
156392df by Cédric Krier at 2023-02-13T14:46:53+01:00
Add guidelines for commit messages
- - - - -
1 changed file:
- templates/develop.html
Changes:
=====================================
templates/develop.html
=====================================
@@ -6,6 +6,7 @@
("Guidelines", 'guidelines', [
("Code", 'guidelines-code', None),
("Documentation", 'guidelines-documentation', None),
+ ("Commit Message", 'commit-message', None),
]),
("Requirements", 'requirements', None),
("Rules", 'rules', None),
@@ -71,6 +72,32 @@
<li>There are some <a href="{{
url_for('guidelines_documentation_help') }}">Help Text Guidelines</a> to follow
if you are writing or changing help text.</li>
<li>If submitting a Howto for approval, then please make sure you've
followed the <a href="{{ url_for('guidelines_documentation_howto') }}">Howto
Guidelines</a>.</li>
</ul>
+ <h3 id="commit-message">Commit Message</h3>
+ <ul>
+ <li>
+ Use a short title starting with a capital letter.
+ <ul>
+ <li>Use imperative mood.<br/>
+ <em>So that it completes the sentence "With this change,
the project will…".</em>
+ </li>
+ <li>
+ Use human names of objects instead of the technical
name.<br/>
+ <em>Like "Invoice" instead of "account.invoice".</em>
+ </li>
+ </ul>
+ </li>
+ <li>Add extra details in the message body (optional).
+ <ul>
+ <li>Less than 80 characters per line.</li>
+ <li>Explain <strong>WHAT</strong> the change is, but most
importantly <strong>WHY</strong> the change is needed.</li>
+ <li>Leave a blank line between the body and the title.</li>
+ <li>Separate paragraphs in the body with blank lines.</li>
+ <li>Use a hyphen (<samp>-</samp>) for bullet points if
needed.</li>
+ <li>Use hanging indents if needed.</li>
+ </ul>
+ </li>
+ <li>Include the <a
href="https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#default-closing-pattern">pattern
to close</a> linked issues (optional).</li>
+ </ul>
</div>
<div class="subsection">
<h2 id="requirements">Requirements</h2>
View it on Heptapod:
https://foss.heptapod.net/tryton/website/-/commit/156392df8e1984a24f9e62fc18d378d1f4b1c94d
--
View it on Heptapod:
https://foss.heptapod.net/tryton/website/-/commit/156392df8e1984a24f9e62fc18d378d1f4b1c94d
You're receiving this email because of your account on foss.heptapod.net.