Skip to content
Snippets Groups Projects
Commit 156392df8e19 authored by Cédric Krier's avatar Cédric Krier :atom:
Browse files

Add guidelines for commit messages

parent 307311e2a9fe
No related branches found
No related tags found
1 merge request!27Add guidelines for commit messages
Pipeline #62925 passed
......@@ -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>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment