Headings

Use short and understandable headings

---

Use sentence case

Capitalize the first word of the title, unless it's a proper noun that starts with lowercase or a code snippet.

👍 Correct code for this rule:

# The quick brown fox jumps over the lazy dog

# React

# `string`

# init main

👎 Incorrect code for this rule:

# The Quick Brown Fox Jumps Over The Lazy Dog

# summer is hot

# react

# `String`

# Init

Verb tense

Use the imperative form, especially when writing the title of a task, because it increases findability. In other words, avoid the gerundive form, because users don't use gerund when searching.

👍 Correct code for this rule:

# Create a dashboard

👎 Incorrect code for this rule:

# Creating a dashboard

Length

Prefer using short header with a maximum length of 80 character (without markers).

Instead of using a long sentence, make the header a summary and write the long sentence as the first paragraph beneath the header.

This makes it effortless to refer to the header later, specially if automatic IDs or a TOC (Table Of Content) are created.

👍 Correct code for this rule:

# One

The summer is sparkling and awesome!

👎 Incorrect code for this rule:

# The summer is sparkling and awesome!

Punctuation after content

Do not use any punctuation at the end of a header for example a trailing (semi)colon ;:, period ., closing marker # or any "sentence amplifier" (!?).

Every header is an introduction to what is about to come next, which is exactly the function of a colon.

The header is not a sentence, or at least only a short sentence, there is no need to add a sentence separator to it.

👍 Correct code for this rule:

# One

Sparkling and awesome.

👎 Incorrect code for this rule:

# One: Sparkling

# One. Frozen.

# One #