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:

Description

Write descriptions in imperative mood and lowercase:

# Good
📝 update documentation contributors

# 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>