Getting Started

We like to have a clean project history. Our commits convention is inspired by Conventional Commits but customized with gitmoji to make it more visual and fun.

Structure

The commit message should be structured as follows and in lowercase:

<gitmoji> <type> <description> [(#<issue number>)]

[optional body]

[optional footer(s)]

Example

📝 update documentation contributors

- Add @jerembdn as a contributor
- Add @younesbessa as a contributor

Co-authored-by: Younes Bessa <younes@onruntime.com>

Most of the time, a simple one-liner is enough:

📝 update documentation contributors

Types

We use the following commit types:

The first commit of a repository uses initial, and a version tag uses release:

🎉 initial commit
🔖 release @onruntime/translations v0.3.0

Description

The <type> is the verb of the subject, and the description completes it. Read together, they make one sentence:

# Good
📝 update documentation contributors

So don't open the description with a second verb. The type is already one, and the subject ends up stacking two sentences, which is what a fix: prefix leads to. Drop the verb and keep what it acted on:

# Bad
💄 improve scale down the gem on its card
🐛 fix stop the footer from wrapping

# Good
💄 improve the gem size on its card
🐛 fix the footer wrapping

Write it in imperative mood and lowercase:

# Bad
📝 updated documentation contributors

# Bad
📝 Update documentation contributors

Issue Number

Link commits to issues by adding the issue number:

📝 update documentation contributors (#123)

Body

Use the body for context and motivation:

📝 update documentation contributors

- Add @jerembdn as a contributor
- Add @younesbessa as a contributor

Co-authored-by: Younes Bessa <younes@onruntime.com>